vector.openapi.json 70 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778
  1. {
  2. "openapi": "3.0.3",
  3. "info": {
  4. "title": "默认模块",
  5. "description": "",
  6. "version": "1.0.0"
  7. },
  8. "servers": [
  9. {
  10. "url": "/",
  11. "description": "默认服务器"
  12. }
  13. ],
  14. "tags": [
  15. {
  16. "name": "vector",
  17. "description": "向量"
  18. }
  19. ],
  20. "paths": {
  21. "/api/ai/vector-store/types": {
  22. "post": {
  23. "summary": "获取支持的向量存储类型列表",
  24. "deprecated": false,
  25. "description": "",
  26. "tags": ["vector"],
  27. "parameters": [
  28. {
  29. "name": "Authorization",
  30. "in": "header",
  31. "description": "",
  32. "example": "bpm_client_1520995593147650048",
  33. "schema": {
  34. "type": "string"
  35. }
  36. }
  37. ],
  38. "requestBody": {
  39. "content": {
  40. "application/json": {
  41. "schema": {
  42. "type": "object",
  43. "properties": {}
  44. },
  45. "example": {}
  46. }
  47. },
  48. "required": true
  49. },
  50. "responses": {
  51. "200": {
  52. "description": "",
  53. "content": {
  54. "application/json": {
  55. "schema": {
  56. "type": "object",
  57. "properties": {
  58. "isSuccess": {
  59. "type": "boolean"
  60. },
  61. "code": {
  62. "type": "integer"
  63. },
  64. "result": {
  65. "type": "array",
  66. "items": {
  67. "type": "object",
  68. "properties": {
  69. "connection_fields": {
  70. "type": "array",
  71. "items": {
  72. "type": "object",
  73. "properties": {
  74. "default": {
  75. "type": "string"
  76. },
  77. "description": {
  78. "type": "string"
  79. },
  80. "immutable": {
  81. "type": "boolean"
  82. },
  83. "name": {
  84. "type": "string"
  85. },
  86. "required": {
  87. "type": "boolean"
  88. },
  89. "sensitive": {
  90. "type": "boolean"
  91. },
  92. "type": {
  93. "type": "string"
  94. }
  95. },
  96. "required": [
  97. "default",
  98. "description",
  99. "immutable",
  100. "name",
  101. "required",
  102. "sensitive",
  103. "type"
  104. ]
  105. }
  106. },
  107. "display_name": {
  108. "type": "string"
  109. },
  110. "index_fields": {
  111. "type": "array",
  112. "items": {
  113. "type": "object",
  114. "properties": {
  115. "default": {
  116. "type": "string"
  117. },
  118. "description": {
  119. "type": "string"
  120. },
  121. "immutable": {
  122. "type": "boolean"
  123. },
  124. "name": {
  125. "type": "string"
  126. },
  127. "required": {
  128. "type": "boolean"
  129. },
  130. "sensitive": {
  131. "type": "boolean"
  132. },
  133. "type": {
  134. "type": "string"
  135. },
  136. "max": {
  137. "type": "integer"
  138. },
  139. "min": {
  140. "type": "integer"
  141. },
  142. "enum": {
  143. "type": "array",
  144. "items": {
  145. "type": "string"
  146. }
  147. }
  148. },
  149. "required": [
  150. "default",
  151. "description",
  152. "immutable",
  153. "name",
  154. "required",
  155. "sensitive",
  156. "type",
  157. "max",
  158. "min"
  159. ]
  160. }
  161. },
  162. "type": {
  163. "type": "string"
  164. }
  165. },
  166. "required": ["connection_fields", "display_name", "index_fields", "type"]
  167. }
  168. },
  169. "isAuthorized": {
  170. "type": "boolean"
  171. }
  172. },
  173. "required": ["isSuccess", "code", "result", "isAuthorized"]
  174. },
  175. "example": {
  176. "isSuccess": true,
  177. "code": 1,
  178. "result": [
  179. {
  180. "connection_fields": [
  181. {
  182. "default": "http://localhost:9200",
  183. "description": "URL",
  184. "immutable": false,
  185. "name": "addr",
  186. "required": true,
  187. "sensitive": false,
  188. "type": "string"
  189. },
  190. {
  191. "default": "elastic",
  192. "description": "Username",
  193. "immutable": false,
  194. "name": "username",
  195. "required": false,
  196. "sensitive": false,
  197. "type": "string"
  198. },
  199. {
  200. "description": "Password",
  201. "immutable": false,
  202. "name": "password",
  203. "required": false,
  204. "sensitive": true,
  205. "type": "string"
  206. }
  207. ],
  208. "display_name": "Elasticsearch",
  209. "index_fields": [
  210. {
  211. "default": "weknora",
  212. "description": "Index Name",
  213. "immutable": false,
  214. "name": "index_name",
  215. "required": false,
  216. "sensitive": false,
  217. "type": "string"
  218. },
  219. {
  220. "default": "4",
  221. "description": "Shards",
  222. "immutable": false,
  223. "name": "number_of_shards",
  224. "required": false,
  225. "sensitive": false,
  226. "type": "number"
  227. },
  228. {
  229. "default": "1",
  230. "description": "Replicas",
  231. "immutable": false,
  232. "name": "number_of_replicas",
  233. "required": false,
  234. "sensitive": false,
  235. "type": "number"
  236. }
  237. ],
  238. "type": "elasticsearch"
  239. },
  240. {
  241. "connection_fields": [
  242. {
  243. "default": "localhost",
  244. "description": "Host",
  245. "immutable": false,
  246. "name": "host",
  247. "required": true,
  248. "sensitive": false,
  249. "type": "string"
  250. },
  251. {
  252. "default": "6334",
  253. "description": "Port",
  254. "immutable": false,
  255. "name": "port",
  256. "required": false,
  257. "sensitive": false,
  258. "type": "number"
  259. },
  260. {
  261. "description": "API Key",
  262. "immutable": false,
  263. "name": "api_key",
  264. "required": false,
  265. "sensitive": true,
  266. "type": "string"
  267. },
  268. {
  269. "default": "false",
  270. "description": "Use TLS",
  271. "immutable": false,
  272. "name": "use_tls",
  273. "required": false,
  274. "sensitive": false,
  275. "type": "boolean"
  276. }
  277. ],
  278. "display_name": "Qdrant",
  279. "index_fields": [
  280. {
  281. "default": "weknora_embeddings",
  282. "description": "Collection Prefix",
  283. "immutable": false,
  284. "name": "collection_prefix",
  285. "required": false,
  286. "sensitive": false,
  287. "type": "string"
  288. },
  289. {
  290. "default": "1",
  291. "description": "Shard Number",
  292. "immutable": false,
  293. "name": "shard_number",
  294. "required": false,
  295. "sensitive": false,
  296. "type": "number"
  297. },
  298. {
  299. "default": "1",
  300. "description": "Replication Factor",
  301. "immutable": false,
  302. "name": "replication_factor",
  303. "required": false,
  304. "sensitive": false,
  305. "type": "number"
  306. }
  307. ],
  308. "type": "qdrant"
  309. },
  310. {
  311. "connection_fields": [
  312. {
  313. "default": "localhost:19530",
  314. "description": "Address",
  315. "immutable": false,
  316. "name": "addr",
  317. "required": true,
  318. "sensitive": false,
  319. "type": "string"
  320. },
  321. {
  322. "description": "Database Name",
  323. "immutable": false,
  324. "name": "database",
  325. "required": false,
  326. "sensitive": false,
  327. "type": "string"
  328. },
  329. {
  330. "default": "root",
  331. "description": "Username",
  332. "immutable": false,
  333. "name": "username",
  334. "required": false,
  335. "sensitive": false,
  336. "type": "string"
  337. },
  338. {
  339. "description": "Password",
  340. "immutable": false,
  341. "name": "password",
  342. "required": false,
  343. "sensitive": true,
  344. "type": "string"
  345. }
  346. ],
  347. "display_name": "Milvus",
  348. "index_fields": [
  349. {
  350. "default": "weknora_embeddings",
  351. "description": "Collection Name",
  352. "immutable": false,
  353. "name": "collection_name",
  354. "required": false,
  355. "sensitive": false,
  356. "type": "string"
  357. },
  358. {
  359. "default": "1",
  360. "description": "Shards (write parallelism)",
  361. "immutable": false,
  362. "name": "shards_num",
  363. "required": false,
  364. "sensitive": false,
  365. "type": "number"
  366. },
  367. {
  368. "default": "1",
  369. "description": "In-memory Replicas (read HA)",
  370. "immutable": false,
  371. "name": "replica_number",
  372. "required": false,
  373. "sensitive": false,
  374. "type": "number"
  375. }
  376. ],
  377. "type": "milvus"
  378. },
  379. {
  380. "connection_fields": [
  381. {
  382. "default": "http://localhost:8080",
  383. "description": "Address",
  384. "immutable": false,
  385. "name": "addr",
  386. "required": true,
  387. "sensitive": false,
  388. "type": "string"
  389. },
  390. {
  391. "description": "Username",
  392. "immutable": false,
  393. "name": "username",
  394. "required": true,
  395. "sensitive": false,
  396. "type": "string"
  397. },
  398. {
  399. "description": "API Key",
  400. "immutable": false,
  401. "name": "api_key",
  402. "required": true,
  403. "sensitive": true,
  404. "type": "string"
  405. },
  406. {
  407. "default": "weknora",
  408. "description": "Database",
  409. "immutable": false,
  410. "name": "database",
  411. "required": false,
  412. "sensitive": false,
  413. "type": "string"
  414. }
  415. ],
  416. "display_name": "Tencent VectorDB",
  417. "index_fields": [
  418. {
  419. "default": "weknora_embeddings",
  420. "description": "Collection Name",
  421. "immutable": false,
  422. "name": "collection_name",
  423. "required": false,
  424. "sensitive": false,
  425. "type": "string"
  426. },
  427. {
  428. "default": "1",
  429. "description": "Shards",
  430. "immutable": false,
  431. "name": "shards_num",
  432. "required": false,
  433. "sensitive": false,
  434. "type": "number"
  435. },
  436. {
  437. "default": "1",
  438. "description": "Replicas",
  439. "immutable": false,
  440. "name": "replica_number",
  441. "required": false,
  442. "sensitive": false,
  443. "type": "number"
  444. }
  445. ],
  446. "type": "tencent_vectordb"
  447. },
  448. {
  449. "connection_fields": [
  450. {
  451. "default": "weaviate:8080",
  452. "description": "Host",
  453. "immutable": false,
  454. "name": "host",
  455. "required": true,
  456. "sensitive": false,
  457. "type": "string"
  458. },
  459. {
  460. "default": "weaviate:50051",
  461. "description": "gRPC Address",
  462. "immutable": false,
  463. "name": "grpc_address",
  464. "required": false,
  465. "sensitive": false,
  466. "type": "string"
  467. },
  468. {
  469. "default": "http",
  470. "description": "Scheme",
  471. "immutable": false,
  472. "name": "scheme",
  473. "required": false,
  474. "sensitive": false,
  475. "type": "string"
  476. },
  477. {
  478. "description": "API Key",
  479. "immutable": false,
  480. "name": "api_key",
  481. "required": false,
  482. "sensitive": true,
  483. "type": "string"
  484. }
  485. ],
  486. "display_name": "Weaviate",
  487. "index_fields": [
  488. {
  489. "default": "Weknora_embeddings",
  490. "description": "Collection Prefix",
  491. "immutable": false,
  492. "name": "collection_prefix",
  493. "required": false,
  494. "sensitive": false,
  495. "type": "string"
  496. },
  497. {
  498. "default": "1",
  499. "description": "Shard Count",
  500. "immutable": false,
  501. "name": "desired_shard_count",
  502. "required": false,
  503. "sensitive": false,
  504. "type": "number"
  505. },
  506. {
  507. "default": "1",
  508. "description": "Replication Factor",
  509. "immutable": false,
  510. "name": "replication_factor",
  511. "required": false,
  512. "sensitive": false,
  513. "type": "number"
  514. }
  515. ],
  516. "type": "weaviate"
  517. },
  518. {
  519. "connection_fields": [
  520. {
  521. "default": "doris-fe:9030",
  522. "description": "FE MySQL Address (host:port)",
  523. "immutable": false,
  524. "name": "addr",
  525. "required": true,
  526. "sensitive": false,
  527. "type": "string"
  528. },
  529. {
  530. "default": "8030",
  531. "description": "FE HTTP Port (Stream Load)",
  532. "immutable": false,
  533. "name": "http_port",
  534. "required": false,
  535. "sensitive": false,
  536. "type": "number"
  537. },
  538. {
  539. "default": "weknora",
  540. "description": "Database",
  541. "immutable": false,
  542. "name": "database",
  543. "required": true,
  544. "sensitive": false,
  545. "type": "string"
  546. },
  547. {
  548. "default": "root",
  549. "description": "Username",
  550. "immutable": false,
  551. "name": "username",
  552. "required": false,
  553. "sensitive": false,
  554. "type": "string"
  555. },
  556. {
  557. "description": "Password",
  558. "immutable": false,
  559. "name": "password",
  560. "required": false,
  561. "sensitive": true,
  562. "type": "string"
  563. }
  564. ],
  565. "display_name": "Apache Doris",
  566. "index_fields": [
  567. {
  568. "default": "weknora_embeddings",
  569. "description": "Table Prefix",
  570. "immutable": false,
  571. "name": "collection_prefix",
  572. "required": false,
  573. "sensitive": false,
  574. "type": "string"
  575. },
  576. {
  577. "default": "10",
  578. "description": "Buckets per table",
  579. "immutable": false,
  580. "name": "buckets_num",
  581. "required": false,
  582. "sensitive": false,
  583. "type": "number"
  584. },
  585. {
  586. "default": "1",
  587. "description": "Replication Num",
  588. "immutable": false,
  589. "name": "replication_num",
  590. "required": false,
  591. "sensitive": false,
  592. "type": "number"
  593. }
  594. ],
  595. "type": "doris"
  596. },
  597. {
  598. "connection_fields": [
  599. {
  600. "default": "https://localhost:9200",
  601. "description": "URL",
  602. "immutable": false,
  603. "name": "addr",
  604. "required": true,
  605. "sensitive": false,
  606. "type": "string"
  607. },
  608. {
  609. "default": "admin",
  610. "description": "Username",
  611. "immutable": false,
  612. "name": "username",
  613. "required": false,
  614. "sensitive": false,
  615. "type": "string"
  616. },
  617. {
  618. "description": "Password",
  619. "immutable": false,
  620. "name": "password",
  621. "required": false,
  622. "sensitive": true,
  623. "type": "string"
  624. },
  625. {
  626. "default": "false",
  627. "description": "Skip TLS certificate verification. For self-signed dev clusters only — never enable in production.",
  628. "immutable": false,
  629. "name": "insecure_skip_verify",
  630. "required": false,
  631. "sensitive": false,
  632. "type": "boolean"
  633. }
  634. ],
  635. "display_name": "OpenSearch",
  636. "index_fields": [
  637. {
  638. "default": "weknora",
  639. "description": "Index Name",
  640. "immutable": false,
  641. "name": "index_name",
  642. "required": false,
  643. "sensitive": false,
  644. "type": "string"
  645. },
  646. {
  647. "default": "4",
  648. "description": "Shards",
  649. "immutable": false,
  650. "max": 64,
  651. "min": 1,
  652. "name": "number_of_shards",
  653. "required": false,
  654. "sensitive": false,
  655. "type": "number"
  656. },
  657. {
  658. "default": "1",
  659. "description": "Replicas",
  660. "immutable": false,
  661. "max": 10,
  662. "min": 0,
  663. "name": "number_of_replicas",
  664. "required": false,
  665. "sensitive": false,
  666. "type": "number"
  667. },
  668. {
  669. "default": "16",
  670. "description": "HNSW graph degree (M). Immutable after index creation.",
  671. "immutable": true,
  672. "max": 100,
  673. "min": 2,
  674. "name": "hnsw_m",
  675. "required": false,
  676. "sensitive": false,
  677. "type": "number"
  678. },
  679. {
  680. "default": "100",
  681. "description": "HNSW build candidate list. Higher (e.g. 200-512) improves recall at the cost of build time. Immutable after creation.",
  682. "immutable": true,
  683. "max": 4096,
  684. "min": 2,
  685. "name": "hnsw_ef_construction",
  686. "required": false,
  687. "sensitive": false,
  688. "type": "number"
  689. },
  690. {
  691. "default": "100",
  692. "description": "HNSW search candidate list. Effective on the faiss engine; the lucene engine reads it at query time. Immutable (no settings-update path).",
  693. "immutable": true,
  694. "max": 10000,
  695. "min": 1,
  696. "name": "hnsw_ef_search",
  697. "required": false,
  698. "sensitive": false,
  699. "type": "number"
  700. },
  701. {
  702. "default": "lucene",
  703. "description": "k-NN backend.",
  704. "enum": ["lucene", "faiss"],
  705. "immutable": true,
  706. "name": "knn_engine",
  707. "required": false,
  708. "sensitive": false,
  709. "type": "string"
  710. }
  711. ],
  712. "type": "opensearch"
  713. }
  714. ],
  715. "isAuthorized": true
  716. }
  717. }
  718. },
  719. "headers": {}
  720. }
  721. },
  722. "security": []
  723. }
  724. },
  725. "/api/ai/vector-store/selectList": {
  726. "post": {
  727. "summary": "获取向量选择列表",
  728. "deprecated": false,
  729. "description": "",
  730. "tags": ["vector"],
  731. "parameters": [
  732. {
  733. "name": "Authorization",
  734. "in": "header",
  735. "description": "",
  736. "example": "bpm_client_1520995593147650048",
  737. "schema": {
  738. "type": "string"
  739. }
  740. }
  741. ],
  742. "requestBody": {
  743. "content": {
  744. "application/json": {
  745. "schema": {
  746. "type": "object",
  747. "properties": {
  748. "keyword": {
  749. "type": "string"
  750. }
  751. },
  752. "required": []
  753. },
  754. "example": {
  755. "keyword": ""
  756. }
  757. }
  758. },
  759. "required": true
  760. },
  761. "responses": {
  762. "200": {
  763. "description": "",
  764. "content": {
  765. "application/json": {
  766. "schema": {
  767. "type": "object",
  768. "properties": {
  769. "isSuccess": {
  770. "type": "boolean"
  771. },
  772. "code": {
  773. "type": "integer"
  774. },
  775. "result": {
  776. "type": "array",
  777. "items": {
  778. "type": "object",
  779. "properties": {
  780. "connection_fields": {
  781. "type": "array",
  782. "items": {
  783. "type": "object",
  784. "properties": {
  785. "default": {
  786. "type": "string"
  787. },
  788. "description": {
  789. "type": "string"
  790. },
  791. "immutable": {
  792. "type": "boolean"
  793. },
  794. "name": {
  795. "type": "string"
  796. },
  797. "required": {
  798. "type": "boolean"
  799. },
  800. "sensitive": {
  801. "type": "boolean"
  802. },
  803. "type": {
  804. "type": "string"
  805. }
  806. },
  807. "required": [
  808. "default",
  809. "description",
  810. "immutable",
  811. "name",
  812. "required",
  813. "sensitive",
  814. "type"
  815. ]
  816. }
  817. },
  818. "display_name": {
  819. "type": "string"
  820. },
  821. "index_fields": {
  822. "type": "array",
  823. "items": {
  824. "type": "object",
  825. "properties": {
  826. "default": {
  827. "type": "string"
  828. },
  829. "description": {
  830. "type": "string"
  831. },
  832. "immutable": {
  833. "type": "boolean"
  834. },
  835. "name": {
  836. "type": "string"
  837. },
  838. "required": {
  839. "type": "boolean"
  840. },
  841. "sensitive": {
  842. "type": "boolean"
  843. },
  844. "type": {
  845. "type": "string"
  846. },
  847. "max": {
  848. "type": "integer"
  849. },
  850. "min": {
  851. "type": "integer"
  852. },
  853. "enum": {
  854. "type": "array",
  855. "items": {
  856. "type": "string"
  857. }
  858. }
  859. },
  860. "required": [
  861. "default",
  862. "description",
  863. "immutable",
  864. "name",
  865. "required",
  866. "sensitive",
  867. "type",
  868. "max",
  869. "min"
  870. ]
  871. }
  872. },
  873. "type": {
  874. "type": "string"
  875. }
  876. },
  877. "required": ["connection_fields", "display_name", "index_fields", "type"]
  878. }
  879. },
  880. "isAuthorized": {
  881. "type": "boolean"
  882. }
  883. },
  884. "required": ["isSuccess", "code", "result", "isAuthorized"]
  885. },
  886. "example": {
  887. "isSuccess": true,
  888. "code": 1,
  889. "result": [
  890. {
  891. "connection_fields": [
  892. {
  893. "default": "http://localhost:9200",
  894. "description": "URL",
  895. "immutable": false,
  896. "name": "addr",
  897. "required": true,
  898. "sensitive": false,
  899. "type": "string"
  900. },
  901. {
  902. "default": "elastic",
  903. "description": "Username",
  904. "immutable": false,
  905. "name": "username",
  906. "required": false,
  907. "sensitive": false,
  908. "type": "string"
  909. },
  910. {
  911. "description": "Password",
  912. "immutable": false,
  913. "name": "password",
  914. "required": false,
  915. "sensitive": true,
  916. "type": "string"
  917. }
  918. ],
  919. "display_name": "Elasticsearch",
  920. "index_fields": [
  921. {
  922. "default": "weknora",
  923. "description": "Index Name",
  924. "immutable": false,
  925. "name": "index_name",
  926. "required": false,
  927. "sensitive": false,
  928. "type": "string"
  929. },
  930. {
  931. "default": "4",
  932. "description": "Shards",
  933. "immutable": false,
  934. "name": "number_of_shards",
  935. "required": false,
  936. "sensitive": false,
  937. "type": "number"
  938. },
  939. {
  940. "default": "1",
  941. "description": "Replicas",
  942. "immutable": false,
  943. "name": "number_of_replicas",
  944. "required": false,
  945. "sensitive": false,
  946. "type": "number"
  947. }
  948. ],
  949. "type": "elasticsearch"
  950. }
  951. ],
  952. "isAuthorized": true
  953. }
  954. },
  955. "headers": {}
  956. }
  957. },
  958. "security": []
  959. }
  960. }
  961. },
  962. "/api/ai/vector-store/pageList": {
  963. "post": {
  964. "summary": "获取分页列表",
  965. "deprecated": false,
  966. "description": "",
  967. "tags": ["vector"],
  968. "parameters": [
  969. {
  970. "name": "Authorization",
  971. "in": "header",
  972. "description": "",
  973. "example": "bpm_client_1520995593147650048",
  974. "schema": {
  975. "type": "string"
  976. }
  977. }
  978. ],
  979. "requestBody": {
  980. "content": {
  981. "application/json": {
  982. "schema": {
  983. "type": "object",
  984. "properties": {
  985. "keyword": {
  986. "type": "string"
  987. },
  988. "pageIndex": {
  989. "type": "integer"
  990. },
  991. "pageSize": {
  992. "type": "integer"
  993. }
  994. },
  995. "required": ["keyword", "pageIndex", "pageSize"]
  996. },
  997. "example": {
  998. "keyword": "",
  999. "pageIndex": 1,
  1000. "pageSize": 20
  1001. }
  1002. }
  1003. },
  1004. "required": true
  1005. },
  1006. "responses": {
  1007. "200": {
  1008. "description": "",
  1009. "content": {
  1010. "application/json": {
  1011. "schema": {
  1012. "type": "object",
  1013. "properties": {
  1014. "isSuccess": {
  1015. "type": "boolean"
  1016. },
  1017. "code": {
  1018. "type": "integer"
  1019. },
  1020. "result": {
  1021. "type": "array",
  1022. "items": {
  1023. "type": "object",
  1024. "properties": {
  1025. "connection_fields": {
  1026. "type": "array",
  1027. "items": {
  1028. "type": "object",
  1029. "properties": {
  1030. "default": {
  1031. "type": "string"
  1032. },
  1033. "description": {
  1034. "type": "string"
  1035. },
  1036. "immutable": {
  1037. "type": "boolean"
  1038. },
  1039. "name": {
  1040. "type": "string"
  1041. },
  1042. "required": {
  1043. "type": "boolean"
  1044. },
  1045. "sensitive": {
  1046. "type": "boolean"
  1047. },
  1048. "type": {
  1049. "type": "string"
  1050. }
  1051. },
  1052. "required": [
  1053. "default",
  1054. "description",
  1055. "immutable",
  1056. "name",
  1057. "required",
  1058. "sensitive",
  1059. "type"
  1060. ]
  1061. }
  1062. },
  1063. "display_name": {
  1064. "type": "string"
  1065. },
  1066. "index_fields": {
  1067. "type": "array",
  1068. "items": {
  1069. "type": "object",
  1070. "properties": {
  1071. "default": {
  1072. "type": "string"
  1073. },
  1074. "description": {
  1075. "type": "string"
  1076. },
  1077. "immutable": {
  1078. "type": "boolean"
  1079. },
  1080. "name": {
  1081. "type": "string"
  1082. },
  1083. "required": {
  1084. "type": "boolean"
  1085. },
  1086. "sensitive": {
  1087. "type": "boolean"
  1088. },
  1089. "type": {
  1090. "type": "string"
  1091. },
  1092. "max": {
  1093. "type": "integer"
  1094. },
  1095. "min": {
  1096. "type": "integer"
  1097. },
  1098. "enum": {
  1099. "type": "array",
  1100. "items": {
  1101. "type": "string"
  1102. }
  1103. }
  1104. },
  1105. "required": [
  1106. "default",
  1107. "description",
  1108. "immutable",
  1109. "name",
  1110. "required",
  1111. "sensitive",
  1112. "type",
  1113. "max",
  1114. "min"
  1115. ]
  1116. }
  1117. },
  1118. "type": {
  1119. "type": "string"
  1120. }
  1121. },
  1122. "required": ["connection_fields", "display_name", "index_fields", "type"]
  1123. }
  1124. },
  1125. "isAuthorized": {
  1126. "type": "boolean"
  1127. }
  1128. },
  1129. "required": ["isSuccess", "code", "result", "isAuthorized"]
  1130. },
  1131. "example": {
  1132. "isSuccess": true,
  1133. "code": 1,
  1134. "result": [
  1135. {
  1136. "connection_fields": [
  1137. {
  1138. "default": "http://localhost:9200",
  1139. "description": "URL",
  1140. "immutable": false,
  1141. "name": "addr",
  1142. "required": true,
  1143. "sensitive": false,
  1144. "type": "string"
  1145. },
  1146. {
  1147. "default": "elastic",
  1148. "description": "Username",
  1149. "immutable": false,
  1150. "name": "username",
  1151. "required": false,
  1152. "sensitive": false,
  1153. "type": "string"
  1154. },
  1155. {
  1156. "description": "Password",
  1157. "immutable": false,
  1158. "name": "password",
  1159. "required": false,
  1160. "sensitive": true,
  1161. "type": "string"
  1162. }
  1163. ],
  1164. "display_name": "Elasticsearch",
  1165. "index_fields": [
  1166. {
  1167. "default": "weknora",
  1168. "description": "Index Name",
  1169. "immutable": false,
  1170. "name": "index_name",
  1171. "required": false,
  1172. "sensitive": false,
  1173. "type": "string"
  1174. },
  1175. {
  1176. "default": "4",
  1177. "description": "Shards",
  1178. "immutable": false,
  1179. "name": "number_of_shards",
  1180. "required": false,
  1181. "sensitive": false,
  1182. "type": "number"
  1183. },
  1184. {
  1185. "default": "1",
  1186. "description": "Replicas",
  1187. "immutable": false,
  1188. "name": "number_of_replicas",
  1189. "required": false,
  1190. "sensitive": false,
  1191. "type": "number"
  1192. }
  1193. ],
  1194. "type": "elasticsearch"
  1195. },
  1196. {
  1197. "connection_fields": [
  1198. {
  1199. "default": "localhost",
  1200. "description": "Host",
  1201. "immutable": false,
  1202. "name": "host",
  1203. "required": true,
  1204. "sensitive": false,
  1205. "type": "string"
  1206. },
  1207. {
  1208. "default": "6334",
  1209. "description": "Port",
  1210. "immutable": false,
  1211. "name": "port",
  1212. "required": false,
  1213. "sensitive": false,
  1214. "type": "number"
  1215. },
  1216. {
  1217. "description": "API Key",
  1218. "immutable": false,
  1219. "name": "api_key",
  1220. "required": false,
  1221. "sensitive": true,
  1222. "type": "string"
  1223. },
  1224. {
  1225. "default": "false",
  1226. "description": "Use TLS",
  1227. "immutable": false,
  1228. "name": "use_tls",
  1229. "required": false,
  1230. "sensitive": false,
  1231. "type": "boolean"
  1232. }
  1233. ],
  1234. "display_name": "Qdrant",
  1235. "index_fields": [
  1236. {
  1237. "default": "weknora_embeddings",
  1238. "description": "Collection Prefix",
  1239. "immutable": false,
  1240. "name": "collection_prefix",
  1241. "required": false,
  1242. "sensitive": false,
  1243. "type": "string"
  1244. },
  1245. {
  1246. "default": "1",
  1247. "description": "Shard Number",
  1248. "immutable": false,
  1249. "name": "shard_number",
  1250. "required": false,
  1251. "sensitive": false,
  1252. "type": "number"
  1253. },
  1254. {
  1255. "default": "1",
  1256. "description": "Replication Factor",
  1257. "immutable": false,
  1258. "name": "replication_factor",
  1259. "required": false,
  1260. "sensitive": false,
  1261. "type": "number"
  1262. }
  1263. ],
  1264. "type": "qdrant"
  1265. },
  1266. {
  1267. "connection_fields": [
  1268. {
  1269. "default": "localhost:19530",
  1270. "description": "Address",
  1271. "immutable": false,
  1272. "name": "addr",
  1273. "required": true,
  1274. "sensitive": false,
  1275. "type": "string"
  1276. },
  1277. {
  1278. "description": "Database Name",
  1279. "immutable": false,
  1280. "name": "database",
  1281. "required": false,
  1282. "sensitive": false,
  1283. "type": "string"
  1284. },
  1285. {
  1286. "default": "root",
  1287. "description": "Username",
  1288. "immutable": false,
  1289. "name": "username",
  1290. "required": false,
  1291. "sensitive": false,
  1292. "type": "string"
  1293. },
  1294. {
  1295. "description": "Password",
  1296. "immutable": false,
  1297. "name": "password",
  1298. "required": false,
  1299. "sensitive": true,
  1300. "type": "string"
  1301. }
  1302. ],
  1303. "display_name": "Milvus",
  1304. "index_fields": [
  1305. {
  1306. "default": "weknora_embeddings",
  1307. "description": "Collection Name",
  1308. "immutable": false,
  1309. "name": "collection_name",
  1310. "required": false,
  1311. "sensitive": false,
  1312. "type": "string"
  1313. },
  1314. {
  1315. "default": "1",
  1316. "description": "Shards (write parallelism)",
  1317. "immutable": false,
  1318. "name": "shards_num",
  1319. "required": false,
  1320. "sensitive": false,
  1321. "type": "number"
  1322. },
  1323. {
  1324. "default": "1",
  1325. "description": "In-memory Replicas (read HA)",
  1326. "immutable": false,
  1327. "name": "replica_number",
  1328. "required": false,
  1329. "sensitive": false,
  1330. "type": "number"
  1331. }
  1332. ],
  1333. "type": "milvus"
  1334. },
  1335. {
  1336. "connection_fields": [
  1337. {
  1338. "default": "http://localhost:8080",
  1339. "description": "Address",
  1340. "immutable": false,
  1341. "name": "addr",
  1342. "required": true,
  1343. "sensitive": false,
  1344. "type": "string"
  1345. },
  1346. {
  1347. "description": "Username",
  1348. "immutable": false,
  1349. "name": "username",
  1350. "required": true,
  1351. "sensitive": false,
  1352. "type": "string"
  1353. },
  1354. {
  1355. "description": "API Key",
  1356. "immutable": false,
  1357. "name": "api_key",
  1358. "required": true,
  1359. "sensitive": true,
  1360. "type": "string"
  1361. },
  1362. {
  1363. "default": "weknora",
  1364. "description": "Database",
  1365. "immutable": false,
  1366. "name": "database",
  1367. "required": false,
  1368. "sensitive": false,
  1369. "type": "string"
  1370. }
  1371. ],
  1372. "display_name": "Tencent VectorDB",
  1373. "index_fields": [
  1374. {
  1375. "default": "weknora_embeddings",
  1376. "description": "Collection Name",
  1377. "immutable": false,
  1378. "name": "collection_name",
  1379. "required": false,
  1380. "sensitive": false,
  1381. "type": "string"
  1382. },
  1383. {
  1384. "default": "1",
  1385. "description": "Shards",
  1386. "immutable": false,
  1387. "name": "shards_num",
  1388. "required": false,
  1389. "sensitive": false,
  1390. "type": "number"
  1391. },
  1392. {
  1393. "default": "1",
  1394. "description": "Replicas",
  1395. "immutable": false,
  1396. "name": "replica_number",
  1397. "required": false,
  1398. "sensitive": false,
  1399. "type": "number"
  1400. }
  1401. ],
  1402. "type": "tencent_vectordb"
  1403. },
  1404. {
  1405. "connection_fields": [
  1406. {
  1407. "default": "weaviate:8080",
  1408. "description": "Host",
  1409. "immutable": false,
  1410. "name": "host",
  1411. "required": true,
  1412. "sensitive": false,
  1413. "type": "string"
  1414. },
  1415. {
  1416. "default": "weaviate:50051",
  1417. "description": "gRPC Address",
  1418. "immutable": false,
  1419. "name": "grpc_address",
  1420. "required": false,
  1421. "sensitive": false,
  1422. "type": "string"
  1423. },
  1424. {
  1425. "default": "http",
  1426. "description": "Scheme",
  1427. "immutable": false,
  1428. "name": "scheme",
  1429. "required": false,
  1430. "sensitive": false,
  1431. "type": "string"
  1432. },
  1433. {
  1434. "description": "API Key",
  1435. "immutable": false,
  1436. "name": "api_key",
  1437. "required": false,
  1438. "sensitive": true,
  1439. "type": "string"
  1440. }
  1441. ],
  1442. "display_name": "Weaviate",
  1443. "index_fields": [
  1444. {
  1445. "default": "Weknora_embeddings",
  1446. "description": "Collection Prefix",
  1447. "immutable": false,
  1448. "name": "collection_prefix",
  1449. "required": false,
  1450. "sensitive": false,
  1451. "type": "string"
  1452. },
  1453. {
  1454. "default": "1",
  1455. "description": "Shard Count",
  1456. "immutable": false,
  1457. "name": "desired_shard_count",
  1458. "required": false,
  1459. "sensitive": false,
  1460. "type": "number"
  1461. },
  1462. {
  1463. "default": "1",
  1464. "description": "Replication Factor",
  1465. "immutable": false,
  1466. "name": "replication_factor",
  1467. "required": false,
  1468. "sensitive": false,
  1469. "type": "number"
  1470. }
  1471. ],
  1472. "type": "weaviate"
  1473. },
  1474. {
  1475. "connection_fields": [
  1476. {
  1477. "default": "doris-fe:9030",
  1478. "description": "FE MySQL Address (host:port)",
  1479. "immutable": false,
  1480. "name": "addr",
  1481. "required": true,
  1482. "sensitive": false,
  1483. "type": "string"
  1484. },
  1485. {
  1486. "default": "8030",
  1487. "description": "FE HTTP Port (Stream Load)",
  1488. "immutable": false,
  1489. "name": "http_port",
  1490. "required": false,
  1491. "sensitive": false,
  1492. "type": "number"
  1493. },
  1494. {
  1495. "default": "weknora",
  1496. "description": "Database",
  1497. "immutable": false,
  1498. "name": "database",
  1499. "required": true,
  1500. "sensitive": false,
  1501. "type": "string"
  1502. },
  1503. {
  1504. "default": "root",
  1505. "description": "Username",
  1506. "immutable": false,
  1507. "name": "username",
  1508. "required": false,
  1509. "sensitive": false,
  1510. "type": "string"
  1511. },
  1512. {
  1513. "description": "Password",
  1514. "immutable": false,
  1515. "name": "password",
  1516. "required": false,
  1517. "sensitive": true,
  1518. "type": "string"
  1519. }
  1520. ],
  1521. "display_name": "Apache Doris",
  1522. "index_fields": [
  1523. {
  1524. "default": "weknora_embeddings",
  1525. "description": "Table Prefix",
  1526. "immutable": false,
  1527. "name": "collection_prefix",
  1528. "required": false,
  1529. "sensitive": false,
  1530. "type": "string"
  1531. },
  1532. {
  1533. "default": "10",
  1534. "description": "Buckets per table",
  1535. "immutable": false,
  1536. "name": "buckets_num",
  1537. "required": false,
  1538. "sensitive": false,
  1539. "type": "number"
  1540. },
  1541. {
  1542. "default": "1",
  1543. "description": "Replication Num",
  1544. "immutable": false,
  1545. "name": "replication_num",
  1546. "required": false,
  1547. "sensitive": false,
  1548. "type": "number"
  1549. }
  1550. ],
  1551. "type": "doris"
  1552. },
  1553. {
  1554. "connection_fields": [
  1555. {
  1556. "default": "https://localhost:9200",
  1557. "description": "URL",
  1558. "immutable": false,
  1559. "name": "addr",
  1560. "required": true,
  1561. "sensitive": false,
  1562. "type": "string"
  1563. },
  1564. {
  1565. "default": "admin",
  1566. "description": "Username",
  1567. "immutable": false,
  1568. "name": "username",
  1569. "required": false,
  1570. "sensitive": false,
  1571. "type": "string"
  1572. },
  1573. {
  1574. "description": "Password",
  1575. "immutable": false,
  1576. "name": "password",
  1577. "required": false,
  1578. "sensitive": true,
  1579. "type": "string"
  1580. },
  1581. {
  1582. "default": "false",
  1583. "description": "Skip TLS certificate verification. For self-signed dev clusters only — never enable in production.",
  1584. "immutable": false,
  1585. "name": "insecure_skip_verify",
  1586. "required": false,
  1587. "sensitive": false,
  1588. "type": "boolean"
  1589. }
  1590. ],
  1591. "display_name": "OpenSearch",
  1592. "index_fields": [
  1593. {
  1594. "default": "weknora",
  1595. "description": "Index Name",
  1596. "immutable": false,
  1597. "name": "index_name",
  1598. "required": false,
  1599. "sensitive": false,
  1600. "type": "string"
  1601. },
  1602. {
  1603. "default": "4",
  1604. "description": "Shards",
  1605. "immutable": false,
  1606. "max": 64,
  1607. "min": 1,
  1608. "name": "number_of_shards",
  1609. "required": false,
  1610. "sensitive": false,
  1611. "type": "number"
  1612. },
  1613. {
  1614. "default": "1",
  1615. "description": "Replicas",
  1616. "immutable": false,
  1617. "max": 10,
  1618. "min": 0,
  1619. "name": "number_of_replicas",
  1620. "required": false,
  1621. "sensitive": false,
  1622. "type": "number"
  1623. },
  1624. {
  1625. "default": "16",
  1626. "description": "HNSW graph degree (M). Immutable after index creation.",
  1627. "immutable": true,
  1628. "max": 100,
  1629. "min": 2,
  1630. "name": "hnsw_m",
  1631. "required": false,
  1632. "sensitive": false,
  1633. "type": "number"
  1634. },
  1635. {
  1636. "default": "100",
  1637. "description": "HNSW build candidate list. Higher (e.g. 200-512) improves recall at the cost of build time. Immutable after creation.",
  1638. "immutable": true,
  1639. "max": 4096,
  1640. "min": 2,
  1641. "name": "hnsw_ef_construction",
  1642. "required": false,
  1643. "sensitive": false,
  1644. "type": "number"
  1645. },
  1646. {
  1647. "default": "100",
  1648. "description": "HNSW search candidate list. Effective on the faiss engine; the lucene engine reads it at query time. Immutable (no settings-update path).",
  1649. "immutable": true,
  1650. "max": 10000,
  1651. "min": 1,
  1652. "name": "hnsw_ef_search",
  1653. "required": false,
  1654. "sensitive": false,
  1655. "type": "number"
  1656. },
  1657. {
  1658. "default": "lucene",
  1659. "description": "k-NN backend.",
  1660. "enum": ["lucene", "faiss"],
  1661. "immutable": true,
  1662. "name": "knn_engine",
  1663. "required": false,
  1664. "sensitive": false,
  1665. "type": "string"
  1666. }
  1667. ],
  1668. "type": "opensearch"
  1669. }
  1670. ],
  1671. "isAuthorized": true
  1672. }
  1673. }
  1674. },
  1675. "headers": {}
  1676. }
  1677. },
  1678. "security": []
  1679. }
  1680. },
  1681. "/api/ai/vector-store/info": {
  1682. "post": {
  1683. "summary": "获取详情",
  1684. "deprecated": false,
  1685. "description": "",
  1686. "tags": ["vector"],
  1687. "parameters": [
  1688. {
  1689. "name": "Authorization",
  1690. "in": "header",
  1691. "description": "",
  1692. "example": "bpm_client_1520995593147650048",
  1693. "schema": {
  1694. "type": "string"
  1695. }
  1696. }
  1697. ],
  1698. "requestBody": {
  1699. "content": {
  1700. "application/json": {
  1701. "schema": {
  1702. "type": "object",
  1703. "properties": {
  1704. "id": {
  1705. "type": "string"
  1706. }
  1707. },
  1708. "required": ["id"]
  1709. },
  1710. "example": {
  1711. "id": "aca5124a-171e-4edb-abe7-181733258d59"
  1712. }
  1713. }
  1714. },
  1715. "required": true
  1716. },
  1717. "responses": {
  1718. "200": {
  1719. "description": "",
  1720. "content": {
  1721. "application/json": {
  1722. "schema": {
  1723. "type": "object",
  1724. "properties": {
  1725. "isSuccess": {
  1726. "type": "boolean"
  1727. },
  1728. "code": {
  1729. "type": "integer"
  1730. },
  1731. "result": {
  1732. "type": "object",
  1733. "properties": {
  1734. "connection_config": {
  1735. "type": "object",
  1736. "properties": {
  1737. "addr": {
  1738. "type": "string"
  1739. },
  1740. "version": {
  1741. "type": "string"
  1742. },
  1743. "username": {
  1744. "type": "string"
  1745. }
  1746. },
  1747. "required": ["addr", "version", "username"]
  1748. },
  1749. "creationTime": {
  1750. "type": "string"
  1751. },
  1752. "creatorUserId": {
  1753. "type": "string"
  1754. },
  1755. "engine_type": {
  1756. "type": "string"
  1757. },
  1758. "id": {
  1759. "type": "string"
  1760. },
  1761. "index_config": {
  1762. "type": "object",
  1763. "properties": {
  1764. "number_of_shards": {
  1765. "type": "integer"
  1766. },
  1767. "index_name": {
  1768. "type": "string"
  1769. },
  1770. "number_of_replicas": {
  1771. "type": "integer"
  1772. }
  1773. },
  1774. "required": ["number_of_shards", "index_name", "number_of_replicas"]
  1775. },
  1776. "isDeleted": {
  1777. "type": "boolean"
  1778. },
  1779. "name": {
  1780. "type": "string"
  1781. },
  1782. "source": {
  1783. "type": "string"
  1784. },
  1785. "updateTime": {
  1786. "type": "string"
  1787. },
  1788. "userId": {
  1789. "type": "string"
  1790. }
  1791. },
  1792. "required": [
  1793. "connection_config",
  1794. "creationTime",
  1795. "creatorUserId",
  1796. "engine_type",
  1797. "id",
  1798. "index_config",
  1799. "isDeleted",
  1800. "name",
  1801. "source",
  1802. "updateTime",
  1803. "userId"
  1804. ]
  1805. },
  1806. "isAuthorized": {
  1807. "type": "boolean"
  1808. }
  1809. },
  1810. "required": ["isSuccess", "code", "result", "isAuthorized"]
  1811. },
  1812. "example": {
  1813. "isSuccess": true,
  1814. "code": 1,
  1815. "result": {
  1816. "connection_config": {
  1817. "addr": "http://es.shalu.com",
  1818. "version": "8.10.4",
  1819. "username": "elastic"
  1820. },
  1821. "creationTime": "2026-06-08 21:58:08",
  1822. "creatorUserId": "7F8A2BFE-402D-4499-9BB8-2EF7FFC7B993",
  1823. "engine_type": "elasticsearch",
  1824. "id": "2311f372-21b0-4956-ac1e-61d3c49fa606",
  1825. "index_config": {
  1826. "number_of_shards": 4,
  1827. "index_name": "shalu",
  1828. "number_of_replicas": 1
  1829. },
  1830. "isDeleted": false,
  1831. "name": "Elasticsearch",
  1832. "source": "user",
  1833. "updateTime": "2026-06-08 21:58:08",
  1834. "userId": "7F8A2BFE-402D-4499-9BB8-2EF7FFC7B993"
  1835. },
  1836. "isAuthorized": true
  1837. }
  1838. }
  1839. },
  1840. "headers": {}
  1841. }
  1842. },
  1843. "security": []
  1844. }
  1845. },
  1846. "/api/ai/vector-store/create": {
  1847. "post": {
  1848. "summary": "创建向量存储",
  1849. "deprecated": false,
  1850. "description": "",
  1851. "tags": ["vector"],
  1852. "parameters": [
  1853. {
  1854. "name": "Authorization",
  1855. "in": "header",
  1856. "description": "",
  1857. "example": "bpm_client_1520995593147650048",
  1858. "schema": {
  1859. "type": "string"
  1860. }
  1861. }
  1862. ],
  1863. "requestBody": {
  1864. "content": {
  1865. "application/json": {
  1866. "schema": {
  1867. "type": "object",
  1868. "properties": {
  1869. "name": {
  1870. "type": "string"
  1871. },
  1872. "engine_type": {
  1873. "type": "string"
  1874. },
  1875. "connection_config": {
  1876. "type": "object",
  1877. "properties": {
  1878. "addr": {
  1879. "type": "string"
  1880. },
  1881. "username": {
  1882. "type": "string"
  1883. },
  1884. "password": {
  1885. "type": "string"
  1886. }
  1887. },
  1888. "required": ["addr", "username", "password"]
  1889. },
  1890. "index_config": {
  1891. "type": "object",
  1892. "properties": {
  1893. "index_name": {
  1894. "type": "string"
  1895. },
  1896. "number_of_shards": {
  1897. "type": "integer"
  1898. },
  1899. "number_of_replicas": {
  1900. "type": "integer"
  1901. }
  1902. },
  1903. "required": ["index_name", "number_of_shards", "number_of_replicas"]
  1904. }
  1905. },
  1906. "required": ["name", "engine_type", "connection_config", "index_config"]
  1907. },
  1908. "examples": {
  1909. "1": {
  1910. "value": {
  1911. "name": "Elasticsearch",
  1912. "engine_type": "elasticsearch",
  1913. "connection_config": {
  1914. "addr": "http://es.shalu.com",
  1915. "username": "elastic",
  1916. "password": ""
  1917. },
  1918. "index_config": {
  1919. "index_name": "shalu",
  1920. "number_of_shards": 4,
  1921. "number_of_replicas": 1
  1922. }
  1923. },
  1924. "summary": "Elasticsearch"
  1925. },
  1926. "2": {
  1927. "value": {
  1928. "name": "Doris",
  1929. "engine_type": "doris",
  1930. "connection_config": {
  1931. "addr": "doris-fe:9030",
  1932. "http_port": 8030,
  1933. "database": "shalu",
  1934. "user": "username",
  1935. "password": ""
  1936. },
  1937. "index_config": {
  1938. "collection_prefix": "shalu",
  1939. "buckets_num": 10,
  1940. "replication_num": 1
  1941. }
  1942. },
  1943. "summary": "Doris"
  1944. },
  1945. "3": {
  1946. "value": {
  1947. "name": "Milvus",
  1948. "engine_type": "milvus",
  1949. "connection_config": {
  1950. "addr": "localhost:19530",
  1951. "database": "shalu",
  1952. "username": "root",
  1953. "password": ""
  1954. },
  1955. "index_config": {
  1956. "collection_name": "shalu",
  1957. "shards_num": 1,
  1958. "replica_number": 1
  1959. }
  1960. },
  1961. "summary": "Milvus"
  1962. },
  1963. "4": {
  1964. "value": {
  1965. "name": "OpenSearch",
  1966. "engine_type": "opensearch",
  1967. "connection_config": {
  1968. "addr": "https://localhost:9200",
  1969. "username": "admin",
  1970. "password": "",
  1971. "insecure_skip_verify": false
  1972. },
  1973. "index_config": {
  1974. "index_name": "shalu",
  1975. "number_of_shards": 4,
  1976. "number_of_replicas": 1,
  1977. "hnsw_m": 16,
  1978. "hnsw_ef_construction": 100,
  1979. "hnsw_ef_search": 100,
  1980. "knn_engine": "lucene"
  1981. }
  1982. },
  1983. "summary": "OpenSearch"
  1984. },
  1985. "5": {
  1986. "value": {
  1987. "name": "Qdrant",
  1988. "engine_type": "qdrant",
  1989. "connection_config": {
  1990. "host": "localhost",
  1991. "port": 6334,
  1992. "api_key": "",
  1993. "use_tls": false
  1994. },
  1995. "index_config": {
  1996. "collection_prefix": "shalu",
  1997. "shard_number": 1,
  1998. "replication_factor": 1
  1999. }
  2000. },
  2001. "summary": "Qdrant"
  2002. },
  2003. "6": {
  2004. "value": {
  2005. "name": "TencentVectorDB",
  2006. "engine_type": "tencent_vectordb",
  2007. "connection_config": {
  2008. "addr": "http://localhost:8080",
  2009. "username": "shalu",
  2010. "port": 6334,
  2011. "api_key": "",
  2012. "database": ""
  2013. },
  2014. "index_config": {
  2015. "collection_name": "shalu",
  2016. "shards_num": 1,
  2017. "replica_number": 1
  2018. }
  2019. },
  2020. "summary": "TencentVectorDB"
  2021. },
  2022. "7": {
  2023. "value": {
  2024. "name": "Weaviate",
  2025. "engine_type": "weaviate",
  2026. "connection_config": {
  2027. "host": "weaviate:8080",
  2028. "grpc_address": "weaviate:50051",
  2029. "scheme": "http",
  2030. "api_key": ""
  2031. },
  2032. "index_config": {
  2033. "collection_prefix": "shalu",
  2034. "desired_shard_count": 1,
  2035. "replication_factor": 1
  2036. }
  2037. },
  2038. "summary": "Weaviate"
  2039. }
  2040. }
  2041. }
  2042. },
  2043. "required": true
  2044. },
  2045. "responses": {
  2046. "200": {
  2047. "description": "",
  2048. "content": {
  2049. "application/json": {
  2050. "schema": {
  2051. "type": "object",
  2052. "properties": {
  2053. "isSuccess": {
  2054. "type": "boolean"
  2055. },
  2056. "code": {
  2057. "type": "integer"
  2058. },
  2059. "result": {
  2060. "type": "object",
  2061. "properties": {
  2062. "connection_config": {
  2063. "type": "object",
  2064. "properties": {
  2065. "addr": {
  2066. "type": "string"
  2067. },
  2068. "version": {
  2069. "type": "string"
  2070. },
  2071. "username": {
  2072. "type": "string"
  2073. }
  2074. },
  2075. "required": ["addr", "version", "username"]
  2076. },
  2077. "creationTime": {
  2078. "type": "string"
  2079. },
  2080. "creatorUserId": {
  2081. "type": "string"
  2082. },
  2083. "engine_type": {
  2084. "type": "string"
  2085. },
  2086. "id": {
  2087. "type": "string"
  2088. },
  2089. "index_config": {
  2090. "type": "object",
  2091. "properties": {
  2092. "number_of_shards": {
  2093. "type": "integer"
  2094. },
  2095. "index_name": {
  2096. "type": "string"
  2097. },
  2098. "number_of_replicas": {
  2099. "type": "integer"
  2100. }
  2101. },
  2102. "required": ["number_of_shards", "index_name", "number_of_replicas"]
  2103. },
  2104. "isDeleted": {
  2105. "type": "boolean"
  2106. },
  2107. "name": {
  2108. "type": "string"
  2109. },
  2110. "source": {
  2111. "type": "string"
  2112. },
  2113. "updateTime": {
  2114. "type": "string"
  2115. },
  2116. "userId": {
  2117. "type": "string"
  2118. }
  2119. },
  2120. "required": [
  2121. "connection_config",
  2122. "creationTime",
  2123. "creatorUserId",
  2124. "engine_type",
  2125. "id",
  2126. "index_config",
  2127. "isDeleted",
  2128. "name",
  2129. "source",
  2130. "updateTime",
  2131. "userId"
  2132. ]
  2133. },
  2134. "isAuthorized": {
  2135. "type": "boolean"
  2136. }
  2137. },
  2138. "required": ["isSuccess", "code", "result", "isAuthorized"]
  2139. },
  2140. "example": {
  2141. "isSuccess": true,
  2142. "code": 1,
  2143. "result": {
  2144. "connection_config": {
  2145. "addr": "http://es.shalu.com",
  2146. "version": "8.10.4",
  2147. "username": "elastic"
  2148. },
  2149. "creationTime": "2026-06-08 21:58:07",
  2150. "creatorUserId": "7F8A2BFE-402D-4499-9BB8-2EF7FFC7B993",
  2151. "engine_type": "elasticsearch",
  2152. "id": "2311f372-21b0-4956-ac1e-61d3c49fa606",
  2153. "index_config": {
  2154. "number_of_shards": 4,
  2155. "index_name": "shalu",
  2156. "number_of_replicas": 1
  2157. },
  2158. "isDeleted": false,
  2159. "name": "Elasticsearch",
  2160. "source": "user",
  2161. "updateTime": "2026-06-08 21:58:07",
  2162. "userId": "7F8A2BFE-402D-4499-9BB8-2EF7FFC7B993"
  2163. },
  2164. "isAuthorized": true
  2165. }
  2166. }
  2167. },
  2168. "headers": {}
  2169. }
  2170. },
  2171. "security": []
  2172. }
  2173. },
  2174. "/api/ai/vector-store/update": {
  2175. "post": {
  2176. "summary": "更新向量存储 ",
  2177. "deprecated": false,
  2178. "description": "",
  2179. "tags": ["vector"],
  2180. "parameters": [
  2181. {
  2182. "name": "Authorization",
  2183. "in": "header",
  2184. "description": "",
  2185. "example": "bpm_client_1520995593147650048",
  2186. "schema": {
  2187. "type": "string"
  2188. }
  2189. }
  2190. ],
  2191. "requestBody": {
  2192. "content": {
  2193. "application/json": {
  2194. "schema": {
  2195. "type": "object",
  2196. "properties": {
  2197. "id": {
  2198. "type": "string"
  2199. },
  2200. "name": {
  2201. "type": "string"
  2202. }
  2203. },
  2204. "required": ["id", "name"]
  2205. },
  2206. "example": {
  2207. "id": "2311f372-21b0-4956-ac1e-61d3c49fa606",
  2208. "name": "Elasticsearch"
  2209. }
  2210. }
  2211. },
  2212. "required": true
  2213. },
  2214. "responses": {
  2215. "200": {
  2216. "description": "",
  2217. "content": {
  2218. "application/json": {
  2219. "schema": {
  2220. "type": "object",
  2221. "properties": {
  2222. "isSuccess": {
  2223. "type": "boolean"
  2224. },
  2225. "code": {
  2226. "type": "integer"
  2227. },
  2228. "isAuthorized": {
  2229. "type": "boolean"
  2230. }
  2231. },
  2232. "required": ["isSuccess", "code", "isAuthorized"]
  2233. },
  2234. "example": {
  2235. "isSuccess": true,
  2236. "code": 1,
  2237. "isAuthorized": true
  2238. }
  2239. }
  2240. },
  2241. "headers": {}
  2242. }
  2243. },
  2244. "security": []
  2245. }
  2246. },
  2247. "/api/ai/vector-store/delete": {
  2248. "post": {
  2249. "summary": "删除向量存储",
  2250. "deprecated": false,
  2251. "description": "",
  2252. "tags": ["vector"],
  2253. "parameters": [
  2254. {
  2255. "name": "Authorization",
  2256. "in": "header",
  2257. "description": "",
  2258. "example": "bpm_client_1520995593147650048",
  2259. "schema": {
  2260. "type": "string"
  2261. }
  2262. }
  2263. ],
  2264. "requestBody": {
  2265. "content": {
  2266. "application/json": {
  2267. "schema": {
  2268. "type": "object",
  2269. "properties": {
  2270. "id": {
  2271. "type": "string"
  2272. }
  2273. },
  2274. "required": ["id"]
  2275. },
  2276. "example": {
  2277. "id": "2311f372-21b0-4956-ac1e-61d3c49fa606"
  2278. }
  2279. }
  2280. },
  2281. "required": true
  2282. },
  2283. "responses": {
  2284. "200": {
  2285. "description": "",
  2286. "content": {
  2287. "application/json": {
  2288. "schema": {
  2289. "type": "object",
  2290. "properties": {
  2291. "isSuccess": {
  2292. "type": "boolean"
  2293. },
  2294. "code": {
  2295. "type": "integer"
  2296. },
  2297. "isAuthorized": {
  2298. "type": "boolean"
  2299. }
  2300. },
  2301. "required": ["isSuccess", "code", "isAuthorized"]
  2302. },
  2303. "example": {
  2304. "isSuccess": true,
  2305. "code": 1,
  2306. "isAuthorized": true
  2307. }
  2308. }
  2309. },
  2310. "headers": {}
  2311. }
  2312. },
  2313. "security": []
  2314. }
  2315. },
  2316. "/api/ai/vector-store/connect_test_config": {
  2317. "post": {
  2318. "summary": "使用原始凭据测试连接",
  2319. "deprecated": false,
  2320. "description": "",
  2321. "tags": ["vector"],
  2322. "parameters": [
  2323. {
  2324. "name": "Authorization",
  2325. "in": "header",
  2326. "description": "",
  2327. "example": "bpm_client_1520995593147650048",
  2328. "schema": {
  2329. "type": "string"
  2330. }
  2331. }
  2332. ],
  2333. "requestBody": {
  2334. "content": {
  2335. "application/json": {
  2336. "schema": {
  2337. "type": "object",
  2338. "properties": {
  2339. "engine_type": {
  2340. "type": "string"
  2341. },
  2342. "connection_config": {
  2343. "type": "object",
  2344. "properties": {
  2345. "addr": {
  2346. "type": "string"
  2347. },
  2348. "username": {
  2349. "type": "string"
  2350. },
  2351. "password": {
  2352. "type": "string"
  2353. }
  2354. },
  2355. "required": ["addr", "username", "password"]
  2356. }
  2357. },
  2358. "required": ["engine_type", "connection_config"]
  2359. },
  2360. "example": {
  2361. "engine_type": "elasticsearch",
  2362. "connection_config": {
  2363. "addr": "http://es.shalu.com",
  2364. "username": "elastic",
  2365. "password": ""
  2366. }
  2367. }
  2368. }
  2369. },
  2370. "required": true
  2371. },
  2372. "responses": {
  2373. "200": {
  2374. "description": "",
  2375. "content": {
  2376. "application/json": {
  2377. "schema": {
  2378. "type": "object",
  2379. "properties": {
  2380. "isSuccess": {
  2381. "type": "boolean"
  2382. },
  2383. "code": {
  2384. "type": "integer"
  2385. },
  2386. "result": {
  2387. "type": "object",
  2388. "properties": {
  2389. "version": {
  2390. "type": "string"
  2391. }
  2392. },
  2393. "required": ["version"]
  2394. },
  2395. "isAuthorized": {
  2396. "type": "boolean"
  2397. }
  2398. },
  2399. "required": ["isSuccess", "code", "result", "isAuthorized"]
  2400. },
  2401. "example": {
  2402. "isSuccess": true,
  2403. "code": 1,
  2404. "result": {
  2405. "version": "8.10.4"
  2406. },
  2407. "isAuthorized": true
  2408. }
  2409. }
  2410. },
  2411. "headers": {}
  2412. }
  2413. },
  2414. "security": []
  2415. }
  2416. },
  2417. "/api/ai/vector-store/connect_test_id": {
  2418. "post": {
  2419. "summary": "测试已保存或环境变量存储的连接",
  2420. "deprecated": false,
  2421. "description": "",
  2422. "tags": ["vector"],
  2423. "parameters": [
  2424. {
  2425. "name": "Authorization",
  2426. "in": "header",
  2427. "description": "",
  2428. "example": "bpm_client_1520995593147650048",
  2429. "schema": {
  2430. "type": "string"
  2431. }
  2432. }
  2433. ],
  2434. "requestBody": {
  2435. "content": {
  2436. "application/json": {
  2437. "schema": {
  2438. "type": "object",
  2439. "properties": {
  2440. "id": {
  2441. "type": "string"
  2442. }
  2443. },
  2444. "required": ["id"]
  2445. },
  2446. "example": {
  2447. "id": "aca5124a-171e-4edb-abe7-181733258d59"
  2448. }
  2449. }
  2450. },
  2451. "required": true
  2452. },
  2453. "responses": {
  2454. "200": {
  2455. "description": "",
  2456. "content": {
  2457. "application/json": {
  2458. "schema": {
  2459. "type": "object",
  2460. "properties": {
  2461. "isSuccess": {
  2462. "type": "boolean"
  2463. },
  2464. "code": {
  2465. "type": "integer"
  2466. },
  2467. "result": {
  2468. "type": "object",
  2469. "properties": {
  2470. "version": {
  2471. "type": "string"
  2472. }
  2473. },
  2474. "required": ["version"]
  2475. },
  2476. "isAuthorized": {
  2477. "type": "boolean"
  2478. }
  2479. },
  2480. "required": ["isSuccess", "code", "result", "isAuthorized"]
  2481. },
  2482. "example": {
  2483. "isSuccess": true,
  2484. "code": 1,
  2485. "result": {
  2486. "version": "8.10.4"
  2487. },
  2488. "isAuthorized": true
  2489. }
  2490. }
  2491. },
  2492. "headers": {}
  2493. }
  2494. },
  2495. "security": []
  2496. }
  2497. }
  2498. },
  2499. "components": {
  2500. "schemas": {
  2501. "AgentNode": {
  2502. "type": "object",
  2503. "properties": {
  2504. "appAgentId": {
  2505. "type": "string",
  2506. "format": "uuid"
  2507. },
  2508. "creationTime": {
  2509. "type": "string",
  2510. "format": "date-time"
  2511. },
  2512. "creatorUserId": {
  2513. "type": "string",
  2514. "format": "uuid"
  2515. },
  2516. "data": {
  2517. "$ref": "#/components/schemas/NodeData"
  2518. },
  2519. "height": {
  2520. "type": "integer"
  2521. },
  2522. "id": {
  2523. "type": "string",
  2524. "format": "uuid"
  2525. },
  2526. "isDeleted": {
  2527. "type": "boolean"
  2528. },
  2529. "position": {
  2530. "type": "object",
  2531. "properties": {
  2532. "x": {
  2533. "type": "integer"
  2534. },
  2535. "y": {
  2536. "type": "integer"
  2537. }
  2538. },
  2539. "required": ["x", "y"]
  2540. },
  2541. "selected": {
  2542. "type": "boolean"
  2543. },
  2544. "type": {
  2545. "type": "string",
  2546. "enum": ["custom", "start", "end", "condition", "task", "http-request"]
  2547. },
  2548. "updateTime": {
  2549. "type": "string",
  2550. "format": "date-time"
  2551. },
  2552. "width": {
  2553. "type": "integer"
  2554. },
  2555. "zIndex": {
  2556. "type": "integer"
  2557. }
  2558. },
  2559. "required": [
  2560. "appAgentId",
  2561. "creationTime",
  2562. "creatorUserId",
  2563. "data",
  2564. "id",
  2565. "position",
  2566. "type"
  2567. ]
  2568. },
  2569. "NodeData": {
  2570. "type": "object",
  2571. "properties": {
  2572. "outputs": {
  2573. "type": "array",
  2574. "items": {
  2575. "type": "object",
  2576. "properties": {
  2577. "name": {
  2578. "type": "string"
  2579. },
  2580. "describe": {
  2581. "type": "string"
  2582. },
  2583. "type": {
  2584. "type": "string",
  2585. "enum": ["string", "number", "boolean", "object", "array"]
  2586. }
  2587. },
  2588. "required": ["name", "describe", "type"]
  2589. }
  2590. },
  2591. "output_can_alter": {
  2592. "type": "boolean"
  2593. },
  2594. "variables": {
  2595. "type": "array",
  2596. "items": {
  2597. "type": "string"
  2598. }
  2599. },
  2600. "method": {
  2601. "type": "string",
  2602. "enum": ["get", "post", "put", "delete", "patch", "head", "options"]
  2603. },
  2604. "ssl_verify": {
  2605. "type": "boolean"
  2606. },
  2607. "isInIteration": {
  2608. "type": "boolean"
  2609. },
  2610. "default_value": {
  2611. "type": "array",
  2612. "items": {
  2613. "type": "string"
  2614. }
  2615. },
  2616. "body": {
  2617. "$ref": "#/components/schemas/RequestBody"
  2618. },
  2619. "params": {
  2620. "type": "array",
  2621. "items": {
  2622. "type": "string"
  2623. }
  2624. },
  2625. "title": {
  2626. "type": "string"
  2627. },
  2628. "type": {
  2629. "type": "string",
  2630. "enum": ["http-request", "condition", "task"]
  2631. },
  2632. "error_strategy": {
  2633. "type": "string",
  2634. "enum": ["none", "retry", "abort", "continue"]
  2635. },
  2636. "retry_config": {
  2637. "type": "object",
  2638. "properties": {
  2639. "max_retries": {
  2640. "type": "integer",
  2641. "minimum": 0,
  2642. "maximum": 10
  2643. },
  2644. "retry_enabled": {
  2645. "type": "boolean"
  2646. },
  2647. "retry_interval": {
  2648. "type": "integer",
  2649. "minimum": 0,
  2650. "maximum": 5000
  2651. }
  2652. },
  2653. "required": ["max_retries", "retry_enabled", "retry_interval"]
  2654. },
  2655. "url": {
  2656. "type": "string",
  2657. "format": "uri"
  2658. },
  2659. "authorization": {
  2660. "type": "object",
  2661. "properties": {
  2662. "type": {
  2663. "type": "string",
  2664. "enum": ["none", "bearer", "basic", "api-key"]
  2665. },
  2666. "config": {
  2667. "type": "object",
  2668. "properties": {
  2669. "api_key": {
  2670. "type": "string"
  2671. },
  2672. "header": {
  2673. "type": "string"
  2674. },
  2675. "type": {
  2676. "type": "string"
  2677. }
  2678. }
  2679. }
  2680. },
  2681. "required": ["type", "config"]
  2682. },
  2683. "timeout_config": {
  2684. "type": "object",
  2685. "properties": {
  2686. "max_write_timeout": {
  2687. "type": "integer",
  2688. "minimum": 0
  2689. },
  2690. "max_read_timeout": {
  2691. "type": "integer",
  2692. "minimum": 0
  2693. },
  2694. "max_connect_timeout": {
  2695. "type": "integer",
  2696. "minimum": 0
  2697. }
  2698. },
  2699. "required": ["max_write_timeout", "max_read_timeout", "max_connect_timeout"]
  2700. },
  2701. "heads": {
  2702. "type": "array",
  2703. "items": {
  2704. "$ref": "#/components/schemas/HttpHeader"
  2705. }
  2706. },
  2707. "selected": {
  2708. "type": "boolean"
  2709. },
  2710. "desc": {
  2711. "type": "string"
  2712. },
  2713. "isInLoop": {
  2714. "type": "boolean"
  2715. }
  2716. },
  2717. "required": ["outputs", "method", "title", "type", "url"]
  2718. },
  2719. "RequestBody": {
  2720. "type": "object",
  2721. "properties": {
  2722. "data": {
  2723. "type": "array",
  2724. "items": {
  2725. "$ref": "#/components/schemas/RequestDataItem"
  2726. }
  2727. },
  2728. "type": {
  2729. "type": "string",
  2730. "enum": ["json", "form-data", "x-www-form-urlencoded", "raw", "binary"]
  2731. }
  2732. },
  2733. "required": ["data", "type"]
  2734. },
  2735. "RequestDataItem": {
  2736. "type": "object",
  2737. "properties": {
  2738. "type": {
  2739. "type": "string",
  2740. "enum": ["text", "file", "json"]
  2741. },
  2742. "value": {
  2743. "type": "string"
  2744. },
  2745. "key": {
  2746. "type": "string"
  2747. }
  2748. },
  2749. "required": ["type", "value"]
  2750. },
  2751. "HttpHeader": {
  2752. "type": "object",
  2753. "properties": {
  2754. "name": {
  2755. "type": "string"
  2756. },
  2757. "value": {
  2758. "type": "string"
  2759. }
  2760. },
  2761. "required": ["name", "value"]
  2762. }
  2763. },
  2764. "securitySchemes": {
  2765. "ApiKeyAuth": {
  2766. "type": "apiKey",
  2767. "in": "header",
  2768. "name": "Authorization"
  2769. }
  2770. }
  2771. },
  2772. "security": [
  2773. {
  2774. "ApiKeyAuth": []
  2775. }
  2776. ]
  2777. }