vector.openapi.json 64 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541
  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/pageList": {
  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. "pageIndex": {
  752. "type": "integer"
  753. },
  754. "pageSize": {
  755. "type": "integer"
  756. }
  757. },
  758. "required": ["keyword", "pageIndex", "pageSize"]
  759. },
  760. "example": {
  761. "keyword": "",
  762. "pageIndex": 1,
  763. "pageSize": 20
  764. }
  765. }
  766. },
  767. "required": true
  768. },
  769. "responses": {
  770. "200": {
  771. "description": "",
  772. "content": {
  773. "application/json": {
  774. "schema": {
  775. "type": "object",
  776. "properties": {
  777. "isSuccess": {
  778. "type": "boolean"
  779. },
  780. "code": {
  781. "type": "integer"
  782. },
  783. "result": {
  784. "type": "array",
  785. "items": {
  786. "type": "object",
  787. "properties": {
  788. "connection_fields": {
  789. "type": "array",
  790. "items": {
  791. "type": "object",
  792. "properties": {
  793. "default": {
  794. "type": "string"
  795. },
  796. "description": {
  797. "type": "string"
  798. },
  799. "immutable": {
  800. "type": "boolean"
  801. },
  802. "name": {
  803. "type": "string"
  804. },
  805. "required": {
  806. "type": "boolean"
  807. },
  808. "sensitive": {
  809. "type": "boolean"
  810. },
  811. "type": {
  812. "type": "string"
  813. }
  814. },
  815. "required": [
  816. "default",
  817. "description",
  818. "immutable",
  819. "name",
  820. "required",
  821. "sensitive",
  822. "type"
  823. ]
  824. }
  825. },
  826. "display_name": {
  827. "type": "string"
  828. },
  829. "index_fields": {
  830. "type": "array",
  831. "items": {
  832. "type": "object",
  833. "properties": {
  834. "default": {
  835. "type": "string"
  836. },
  837. "description": {
  838. "type": "string"
  839. },
  840. "immutable": {
  841. "type": "boolean"
  842. },
  843. "name": {
  844. "type": "string"
  845. },
  846. "required": {
  847. "type": "boolean"
  848. },
  849. "sensitive": {
  850. "type": "boolean"
  851. },
  852. "type": {
  853. "type": "string"
  854. },
  855. "max": {
  856. "type": "integer"
  857. },
  858. "min": {
  859. "type": "integer"
  860. },
  861. "enum": {
  862. "type": "array",
  863. "items": {
  864. "type": "string"
  865. }
  866. }
  867. },
  868. "required": [
  869. "default",
  870. "description",
  871. "immutable",
  872. "name",
  873. "required",
  874. "sensitive",
  875. "type",
  876. "max",
  877. "min"
  878. ]
  879. }
  880. },
  881. "type": {
  882. "type": "string"
  883. }
  884. },
  885. "required": ["connection_fields", "display_name", "index_fields", "type"]
  886. }
  887. },
  888. "isAuthorized": {
  889. "type": "boolean"
  890. }
  891. },
  892. "required": ["isSuccess", "code", "result", "isAuthorized"]
  893. },
  894. "example": {
  895. "isSuccess": true,
  896. "code": 1,
  897. "result": [
  898. {
  899. "connection_fields": [
  900. {
  901. "default": "http://localhost:9200",
  902. "description": "URL",
  903. "immutable": false,
  904. "name": "addr",
  905. "required": true,
  906. "sensitive": false,
  907. "type": "string"
  908. },
  909. {
  910. "default": "elastic",
  911. "description": "Username",
  912. "immutable": false,
  913. "name": "username",
  914. "required": false,
  915. "sensitive": false,
  916. "type": "string"
  917. },
  918. {
  919. "description": "Password",
  920. "immutable": false,
  921. "name": "password",
  922. "required": false,
  923. "sensitive": true,
  924. "type": "string"
  925. }
  926. ],
  927. "display_name": "Elasticsearch",
  928. "index_fields": [
  929. {
  930. "default": "weknora",
  931. "description": "Index Name",
  932. "immutable": false,
  933. "name": "index_name",
  934. "required": false,
  935. "sensitive": false,
  936. "type": "string"
  937. },
  938. {
  939. "default": "4",
  940. "description": "Shards",
  941. "immutable": false,
  942. "name": "number_of_shards",
  943. "required": false,
  944. "sensitive": false,
  945. "type": "number"
  946. },
  947. {
  948. "default": "1",
  949. "description": "Replicas",
  950. "immutable": false,
  951. "name": "number_of_replicas",
  952. "required": false,
  953. "sensitive": false,
  954. "type": "number"
  955. }
  956. ],
  957. "type": "elasticsearch"
  958. },
  959. {
  960. "connection_fields": [
  961. {
  962. "default": "localhost",
  963. "description": "Host",
  964. "immutable": false,
  965. "name": "host",
  966. "required": true,
  967. "sensitive": false,
  968. "type": "string"
  969. },
  970. {
  971. "default": "6334",
  972. "description": "Port",
  973. "immutable": false,
  974. "name": "port",
  975. "required": false,
  976. "sensitive": false,
  977. "type": "number"
  978. },
  979. {
  980. "description": "API Key",
  981. "immutable": false,
  982. "name": "api_key",
  983. "required": false,
  984. "sensitive": true,
  985. "type": "string"
  986. },
  987. {
  988. "default": "false",
  989. "description": "Use TLS",
  990. "immutable": false,
  991. "name": "use_tls",
  992. "required": false,
  993. "sensitive": false,
  994. "type": "boolean"
  995. }
  996. ],
  997. "display_name": "Qdrant",
  998. "index_fields": [
  999. {
  1000. "default": "weknora_embeddings",
  1001. "description": "Collection Prefix",
  1002. "immutable": false,
  1003. "name": "collection_prefix",
  1004. "required": false,
  1005. "sensitive": false,
  1006. "type": "string"
  1007. },
  1008. {
  1009. "default": "1",
  1010. "description": "Shard Number",
  1011. "immutable": false,
  1012. "name": "shard_number",
  1013. "required": false,
  1014. "sensitive": false,
  1015. "type": "number"
  1016. },
  1017. {
  1018. "default": "1",
  1019. "description": "Replication Factor",
  1020. "immutable": false,
  1021. "name": "replication_factor",
  1022. "required": false,
  1023. "sensitive": false,
  1024. "type": "number"
  1025. }
  1026. ],
  1027. "type": "qdrant"
  1028. },
  1029. {
  1030. "connection_fields": [
  1031. {
  1032. "default": "localhost:19530",
  1033. "description": "Address",
  1034. "immutable": false,
  1035. "name": "addr",
  1036. "required": true,
  1037. "sensitive": false,
  1038. "type": "string"
  1039. },
  1040. {
  1041. "description": "Database Name",
  1042. "immutable": false,
  1043. "name": "database",
  1044. "required": false,
  1045. "sensitive": false,
  1046. "type": "string"
  1047. },
  1048. {
  1049. "default": "root",
  1050. "description": "Username",
  1051. "immutable": false,
  1052. "name": "username",
  1053. "required": false,
  1054. "sensitive": false,
  1055. "type": "string"
  1056. },
  1057. {
  1058. "description": "Password",
  1059. "immutable": false,
  1060. "name": "password",
  1061. "required": false,
  1062. "sensitive": true,
  1063. "type": "string"
  1064. }
  1065. ],
  1066. "display_name": "Milvus",
  1067. "index_fields": [
  1068. {
  1069. "default": "weknora_embeddings",
  1070. "description": "Collection Name",
  1071. "immutable": false,
  1072. "name": "collection_name",
  1073. "required": false,
  1074. "sensitive": false,
  1075. "type": "string"
  1076. },
  1077. {
  1078. "default": "1",
  1079. "description": "Shards (write parallelism)",
  1080. "immutable": false,
  1081. "name": "shards_num",
  1082. "required": false,
  1083. "sensitive": false,
  1084. "type": "number"
  1085. },
  1086. {
  1087. "default": "1",
  1088. "description": "In-memory Replicas (read HA)",
  1089. "immutable": false,
  1090. "name": "replica_number",
  1091. "required": false,
  1092. "sensitive": false,
  1093. "type": "number"
  1094. }
  1095. ],
  1096. "type": "milvus"
  1097. },
  1098. {
  1099. "connection_fields": [
  1100. {
  1101. "default": "http://localhost:8080",
  1102. "description": "Address",
  1103. "immutable": false,
  1104. "name": "addr",
  1105. "required": true,
  1106. "sensitive": false,
  1107. "type": "string"
  1108. },
  1109. {
  1110. "description": "Username",
  1111. "immutable": false,
  1112. "name": "username",
  1113. "required": true,
  1114. "sensitive": false,
  1115. "type": "string"
  1116. },
  1117. {
  1118. "description": "API Key",
  1119. "immutable": false,
  1120. "name": "api_key",
  1121. "required": true,
  1122. "sensitive": true,
  1123. "type": "string"
  1124. },
  1125. {
  1126. "default": "weknora",
  1127. "description": "Database",
  1128. "immutable": false,
  1129. "name": "database",
  1130. "required": false,
  1131. "sensitive": false,
  1132. "type": "string"
  1133. }
  1134. ],
  1135. "display_name": "Tencent VectorDB",
  1136. "index_fields": [
  1137. {
  1138. "default": "weknora_embeddings",
  1139. "description": "Collection Name",
  1140. "immutable": false,
  1141. "name": "collection_name",
  1142. "required": false,
  1143. "sensitive": false,
  1144. "type": "string"
  1145. },
  1146. {
  1147. "default": "1",
  1148. "description": "Shards",
  1149. "immutable": false,
  1150. "name": "shards_num",
  1151. "required": false,
  1152. "sensitive": false,
  1153. "type": "number"
  1154. },
  1155. {
  1156. "default": "1",
  1157. "description": "Replicas",
  1158. "immutable": false,
  1159. "name": "replica_number",
  1160. "required": false,
  1161. "sensitive": false,
  1162. "type": "number"
  1163. }
  1164. ],
  1165. "type": "tencent_vectordb"
  1166. },
  1167. {
  1168. "connection_fields": [
  1169. {
  1170. "default": "weaviate:8080",
  1171. "description": "Host",
  1172. "immutable": false,
  1173. "name": "host",
  1174. "required": true,
  1175. "sensitive": false,
  1176. "type": "string"
  1177. },
  1178. {
  1179. "default": "weaviate:50051",
  1180. "description": "gRPC Address",
  1181. "immutable": false,
  1182. "name": "grpc_address",
  1183. "required": false,
  1184. "sensitive": false,
  1185. "type": "string"
  1186. },
  1187. {
  1188. "default": "http",
  1189. "description": "Scheme",
  1190. "immutable": false,
  1191. "name": "scheme",
  1192. "required": false,
  1193. "sensitive": false,
  1194. "type": "string"
  1195. },
  1196. {
  1197. "description": "API Key",
  1198. "immutable": false,
  1199. "name": "api_key",
  1200. "required": false,
  1201. "sensitive": true,
  1202. "type": "string"
  1203. }
  1204. ],
  1205. "display_name": "Weaviate",
  1206. "index_fields": [
  1207. {
  1208. "default": "Weknora_embeddings",
  1209. "description": "Collection Prefix",
  1210. "immutable": false,
  1211. "name": "collection_prefix",
  1212. "required": false,
  1213. "sensitive": false,
  1214. "type": "string"
  1215. },
  1216. {
  1217. "default": "1",
  1218. "description": "Shard Count",
  1219. "immutable": false,
  1220. "name": "desired_shard_count",
  1221. "required": false,
  1222. "sensitive": false,
  1223. "type": "number"
  1224. },
  1225. {
  1226. "default": "1",
  1227. "description": "Replication Factor",
  1228. "immutable": false,
  1229. "name": "replication_factor",
  1230. "required": false,
  1231. "sensitive": false,
  1232. "type": "number"
  1233. }
  1234. ],
  1235. "type": "weaviate"
  1236. },
  1237. {
  1238. "connection_fields": [
  1239. {
  1240. "default": "doris-fe:9030",
  1241. "description": "FE MySQL Address (host:port)",
  1242. "immutable": false,
  1243. "name": "addr",
  1244. "required": true,
  1245. "sensitive": false,
  1246. "type": "string"
  1247. },
  1248. {
  1249. "default": "8030",
  1250. "description": "FE HTTP Port (Stream Load)",
  1251. "immutable": false,
  1252. "name": "http_port",
  1253. "required": false,
  1254. "sensitive": false,
  1255. "type": "number"
  1256. },
  1257. {
  1258. "default": "weknora",
  1259. "description": "Database",
  1260. "immutable": false,
  1261. "name": "database",
  1262. "required": true,
  1263. "sensitive": false,
  1264. "type": "string"
  1265. },
  1266. {
  1267. "default": "root",
  1268. "description": "Username",
  1269. "immutable": false,
  1270. "name": "username",
  1271. "required": false,
  1272. "sensitive": false,
  1273. "type": "string"
  1274. },
  1275. {
  1276. "description": "Password",
  1277. "immutable": false,
  1278. "name": "password",
  1279. "required": false,
  1280. "sensitive": true,
  1281. "type": "string"
  1282. }
  1283. ],
  1284. "display_name": "Apache Doris",
  1285. "index_fields": [
  1286. {
  1287. "default": "weknora_embeddings",
  1288. "description": "Table Prefix",
  1289. "immutable": false,
  1290. "name": "collection_prefix",
  1291. "required": false,
  1292. "sensitive": false,
  1293. "type": "string"
  1294. },
  1295. {
  1296. "default": "10",
  1297. "description": "Buckets per table",
  1298. "immutable": false,
  1299. "name": "buckets_num",
  1300. "required": false,
  1301. "sensitive": false,
  1302. "type": "number"
  1303. },
  1304. {
  1305. "default": "1",
  1306. "description": "Replication Num",
  1307. "immutable": false,
  1308. "name": "replication_num",
  1309. "required": false,
  1310. "sensitive": false,
  1311. "type": "number"
  1312. }
  1313. ],
  1314. "type": "doris"
  1315. },
  1316. {
  1317. "connection_fields": [
  1318. {
  1319. "default": "https://localhost:9200",
  1320. "description": "URL",
  1321. "immutable": false,
  1322. "name": "addr",
  1323. "required": true,
  1324. "sensitive": false,
  1325. "type": "string"
  1326. },
  1327. {
  1328. "default": "admin",
  1329. "description": "Username",
  1330. "immutable": false,
  1331. "name": "username",
  1332. "required": false,
  1333. "sensitive": false,
  1334. "type": "string"
  1335. },
  1336. {
  1337. "description": "Password",
  1338. "immutable": false,
  1339. "name": "password",
  1340. "required": false,
  1341. "sensitive": true,
  1342. "type": "string"
  1343. },
  1344. {
  1345. "default": "false",
  1346. "description": "Skip TLS certificate verification. For self-signed dev clusters only — never enable in production.",
  1347. "immutable": false,
  1348. "name": "insecure_skip_verify",
  1349. "required": false,
  1350. "sensitive": false,
  1351. "type": "boolean"
  1352. }
  1353. ],
  1354. "display_name": "OpenSearch",
  1355. "index_fields": [
  1356. {
  1357. "default": "weknora",
  1358. "description": "Index Name",
  1359. "immutable": false,
  1360. "name": "index_name",
  1361. "required": false,
  1362. "sensitive": false,
  1363. "type": "string"
  1364. },
  1365. {
  1366. "default": "4",
  1367. "description": "Shards",
  1368. "immutable": false,
  1369. "max": 64,
  1370. "min": 1,
  1371. "name": "number_of_shards",
  1372. "required": false,
  1373. "sensitive": false,
  1374. "type": "number"
  1375. },
  1376. {
  1377. "default": "1",
  1378. "description": "Replicas",
  1379. "immutable": false,
  1380. "max": 10,
  1381. "min": 0,
  1382. "name": "number_of_replicas",
  1383. "required": false,
  1384. "sensitive": false,
  1385. "type": "number"
  1386. },
  1387. {
  1388. "default": "16",
  1389. "description": "HNSW graph degree (M). Immutable after index creation.",
  1390. "immutable": true,
  1391. "max": 100,
  1392. "min": 2,
  1393. "name": "hnsw_m",
  1394. "required": false,
  1395. "sensitive": false,
  1396. "type": "number"
  1397. },
  1398. {
  1399. "default": "100",
  1400. "description": "HNSW build candidate list. Higher (e.g. 200-512) improves recall at the cost of build time. Immutable after creation.",
  1401. "immutable": true,
  1402. "max": 4096,
  1403. "min": 2,
  1404. "name": "hnsw_ef_construction",
  1405. "required": false,
  1406. "sensitive": false,
  1407. "type": "number"
  1408. },
  1409. {
  1410. "default": "100",
  1411. "description": "HNSW search candidate list. Effective on the faiss engine; the lucene engine reads it at query time. Immutable (no settings-update path).",
  1412. "immutable": true,
  1413. "max": 10000,
  1414. "min": 1,
  1415. "name": "hnsw_ef_search",
  1416. "required": false,
  1417. "sensitive": false,
  1418. "type": "number"
  1419. },
  1420. {
  1421. "default": "lucene",
  1422. "description": "k-NN backend.",
  1423. "enum": ["lucene", "faiss"],
  1424. "immutable": true,
  1425. "name": "knn_engine",
  1426. "required": false,
  1427. "sensitive": false,
  1428. "type": "string"
  1429. }
  1430. ],
  1431. "type": "opensearch"
  1432. }
  1433. ],
  1434. "isAuthorized": true
  1435. }
  1436. }
  1437. },
  1438. "headers": {}
  1439. }
  1440. },
  1441. "security": []
  1442. }
  1443. },
  1444. "/api/ai/vector-store/info": {
  1445. "post": {
  1446. "summary": "获取详情",
  1447. "deprecated": false,
  1448. "description": "",
  1449. "tags": ["vector"],
  1450. "parameters": [
  1451. {
  1452. "name": "Authorization",
  1453. "in": "header",
  1454. "description": "",
  1455. "example": "bpm_client_1520995593147650048",
  1456. "schema": {
  1457. "type": "string"
  1458. }
  1459. }
  1460. ],
  1461. "requestBody": {
  1462. "content": {
  1463. "application/json": {
  1464. "schema": {
  1465. "type": "object",
  1466. "properties": {
  1467. "id": {
  1468. "type": "string"
  1469. }
  1470. },
  1471. "required": ["id"]
  1472. },
  1473. "example": {
  1474. "id": "aca5124a-171e-4edb-abe7-181733258d59"
  1475. }
  1476. }
  1477. },
  1478. "required": true
  1479. },
  1480. "responses": {
  1481. "200": {
  1482. "description": "",
  1483. "content": {
  1484. "application/json": {
  1485. "schema": {
  1486. "type": "object",
  1487. "properties": {
  1488. "isSuccess": {
  1489. "type": "boolean"
  1490. },
  1491. "code": {
  1492. "type": "integer"
  1493. },
  1494. "result": {
  1495. "type": "object",
  1496. "properties": {
  1497. "connection_config": {
  1498. "type": "object",
  1499. "properties": {
  1500. "addr": {
  1501. "type": "string"
  1502. },
  1503. "version": {
  1504. "type": "string"
  1505. },
  1506. "username": {
  1507. "type": "string"
  1508. }
  1509. },
  1510. "required": ["addr", "version", "username"]
  1511. },
  1512. "creationTime": {
  1513. "type": "string"
  1514. },
  1515. "creatorUserId": {
  1516. "type": "string"
  1517. },
  1518. "engine_type": {
  1519. "type": "string"
  1520. },
  1521. "id": {
  1522. "type": "string"
  1523. },
  1524. "index_config": {
  1525. "type": "object",
  1526. "properties": {
  1527. "number_of_shards": {
  1528. "type": "integer"
  1529. },
  1530. "index_name": {
  1531. "type": "string"
  1532. },
  1533. "number_of_replicas": {
  1534. "type": "integer"
  1535. }
  1536. },
  1537. "required": ["number_of_shards", "index_name", "number_of_replicas"]
  1538. },
  1539. "isDeleted": {
  1540. "type": "boolean"
  1541. },
  1542. "name": {
  1543. "type": "string"
  1544. },
  1545. "source": {
  1546. "type": "string"
  1547. },
  1548. "updateTime": {
  1549. "type": "string"
  1550. },
  1551. "userId": {
  1552. "type": "string"
  1553. }
  1554. },
  1555. "required": [
  1556. "connection_config",
  1557. "creationTime",
  1558. "creatorUserId",
  1559. "engine_type",
  1560. "id",
  1561. "index_config",
  1562. "isDeleted",
  1563. "name",
  1564. "source",
  1565. "updateTime",
  1566. "userId"
  1567. ]
  1568. },
  1569. "isAuthorized": {
  1570. "type": "boolean"
  1571. }
  1572. },
  1573. "required": ["isSuccess", "code", "result", "isAuthorized"]
  1574. },
  1575. "example": {
  1576. "isSuccess": true,
  1577. "code": 1,
  1578. "result": {
  1579. "connection_config": {
  1580. "addr": "http://es.shalu.com",
  1581. "version": "8.10.4",
  1582. "username": "elastic"
  1583. },
  1584. "creationTime": "2026-06-08 21:58:08",
  1585. "creatorUserId": "7F8A2BFE-402D-4499-9BB8-2EF7FFC7B993",
  1586. "engine_type": "elasticsearch",
  1587. "id": "2311f372-21b0-4956-ac1e-61d3c49fa606",
  1588. "index_config": {
  1589. "number_of_shards": 4,
  1590. "index_name": "shalu",
  1591. "number_of_replicas": 1
  1592. },
  1593. "isDeleted": false,
  1594. "name": "Elasticsearch",
  1595. "source": "user",
  1596. "updateTime": "2026-06-08 21:58:08",
  1597. "userId": "7F8A2BFE-402D-4499-9BB8-2EF7FFC7B993"
  1598. },
  1599. "isAuthorized": true
  1600. }
  1601. }
  1602. },
  1603. "headers": {}
  1604. }
  1605. },
  1606. "security": []
  1607. }
  1608. },
  1609. "/api/ai/vector-store/create": {
  1610. "post": {
  1611. "summary": "创建向量存储",
  1612. "deprecated": false,
  1613. "description": "",
  1614. "tags": ["vector"],
  1615. "parameters": [
  1616. {
  1617. "name": "Authorization",
  1618. "in": "header",
  1619. "description": "",
  1620. "example": "bpm_client_1520995593147650048",
  1621. "schema": {
  1622. "type": "string"
  1623. }
  1624. }
  1625. ],
  1626. "requestBody": {
  1627. "content": {
  1628. "application/json": {
  1629. "schema": {
  1630. "type": "object",
  1631. "properties": {
  1632. "name": {
  1633. "type": "string"
  1634. },
  1635. "engine_type": {
  1636. "type": "string"
  1637. },
  1638. "connection_config": {
  1639. "type": "object",
  1640. "properties": {
  1641. "addr": {
  1642. "type": "string"
  1643. },
  1644. "username": {
  1645. "type": "string"
  1646. },
  1647. "password": {
  1648. "type": "string"
  1649. }
  1650. },
  1651. "required": ["addr", "username", "password"]
  1652. },
  1653. "index_config": {
  1654. "type": "object",
  1655. "properties": {
  1656. "index_name": {
  1657. "type": "string"
  1658. },
  1659. "number_of_shards": {
  1660. "type": "integer"
  1661. },
  1662. "number_of_replicas": {
  1663. "type": "integer"
  1664. }
  1665. },
  1666. "required": ["index_name", "number_of_shards", "number_of_replicas"]
  1667. }
  1668. },
  1669. "required": ["name", "engine_type", "connection_config", "index_config"]
  1670. },
  1671. "examples": {
  1672. "1": {
  1673. "value": {
  1674. "name": "Elasticsearch",
  1675. "engine_type": "elasticsearch",
  1676. "connection_config": {
  1677. "addr": "http://es.shalu.com",
  1678. "username": "elastic",
  1679. "password": ""
  1680. },
  1681. "index_config": {
  1682. "index_name": "shalu",
  1683. "number_of_shards": 4,
  1684. "number_of_replicas": 1
  1685. }
  1686. },
  1687. "summary": "Elasticsearch"
  1688. },
  1689. "2": {
  1690. "value": {
  1691. "name": "Doris",
  1692. "engine_type": "doris",
  1693. "connection_config": {
  1694. "addr": "doris-fe:9030",
  1695. "http_port": 8030,
  1696. "database": "shalu",
  1697. "user": "username",
  1698. "password": ""
  1699. },
  1700. "index_config": {
  1701. "collection_prefix": "shalu",
  1702. "buckets_num": 10,
  1703. "replication_num": 1
  1704. }
  1705. },
  1706. "summary": "Doris"
  1707. },
  1708. "3": {
  1709. "value": {
  1710. "name": "Milvus",
  1711. "engine_type": "milvus",
  1712. "connection_config": {
  1713. "addr": "localhost:19530",
  1714. "database": "shalu",
  1715. "username": "root",
  1716. "password": ""
  1717. },
  1718. "index_config": {
  1719. "collection_name": "shalu",
  1720. "shards_num": 1,
  1721. "replica_number": 1
  1722. }
  1723. },
  1724. "summary": "Milvus"
  1725. },
  1726. "4": {
  1727. "value": {
  1728. "name": "OpenSearch",
  1729. "engine_type": "opensearch",
  1730. "connection_config": {
  1731. "addr": "https://localhost:9200",
  1732. "username": "admin",
  1733. "password": "",
  1734. "insecure_skip_verify": false
  1735. },
  1736. "index_config": {
  1737. "index_name": "shalu",
  1738. "number_of_shards": 4,
  1739. "number_of_replicas": 1,
  1740. "hnsw_m": 16,
  1741. "hnsw_ef_construction": 100,
  1742. "hnsw_ef_search": 100,
  1743. "knn_engine": "lucene"
  1744. }
  1745. },
  1746. "summary": "OpenSearch"
  1747. },
  1748. "5": {
  1749. "value": {
  1750. "name": "Qdrant",
  1751. "engine_type": "qdrant",
  1752. "connection_config": {
  1753. "host": "localhost",
  1754. "port": 6334,
  1755. "api_key": "",
  1756. "use_tls": false
  1757. },
  1758. "index_config": {
  1759. "collection_prefix": "shalu",
  1760. "shard_number": 1,
  1761. "replication_factor": 1
  1762. }
  1763. },
  1764. "summary": "Qdrant"
  1765. },
  1766. "6": {
  1767. "value": {
  1768. "name": "TencentVectorDB",
  1769. "engine_type": "tencent_vectordb",
  1770. "connection_config": {
  1771. "addr": "http://localhost:8080",
  1772. "username": "shalu",
  1773. "port": 6334,
  1774. "api_key": "",
  1775. "database": ""
  1776. },
  1777. "index_config": {
  1778. "collection_name": "shalu",
  1779. "shards_num": 1,
  1780. "replica_number": 1
  1781. }
  1782. },
  1783. "summary": "TencentVectorDB"
  1784. },
  1785. "7": {
  1786. "value": {
  1787. "name": "Weaviate",
  1788. "engine_type": "weaviate",
  1789. "connection_config": {
  1790. "host": "weaviate:8080",
  1791. "grpc_address": "weaviate:50051",
  1792. "scheme": "http",
  1793. "api_key": ""
  1794. },
  1795. "index_config": {
  1796. "collection_prefix": "shalu",
  1797. "desired_shard_count": 1,
  1798. "replication_factor": 1
  1799. }
  1800. },
  1801. "summary": "Weaviate"
  1802. }
  1803. }
  1804. }
  1805. },
  1806. "required": true
  1807. },
  1808. "responses": {
  1809. "200": {
  1810. "description": "",
  1811. "content": {
  1812. "application/json": {
  1813. "schema": {
  1814. "type": "object",
  1815. "properties": {
  1816. "isSuccess": {
  1817. "type": "boolean"
  1818. },
  1819. "code": {
  1820. "type": "integer"
  1821. },
  1822. "result": {
  1823. "type": "object",
  1824. "properties": {
  1825. "connection_config": {
  1826. "type": "object",
  1827. "properties": {
  1828. "addr": {
  1829. "type": "string"
  1830. },
  1831. "version": {
  1832. "type": "string"
  1833. },
  1834. "username": {
  1835. "type": "string"
  1836. }
  1837. },
  1838. "required": ["addr", "version", "username"]
  1839. },
  1840. "creationTime": {
  1841. "type": "string"
  1842. },
  1843. "creatorUserId": {
  1844. "type": "string"
  1845. },
  1846. "engine_type": {
  1847. "type": "string"
  1848. },
  1849. "id": {
  1850. "type": "string"
  1851. },
  1852. "index_config": {
  1853. "type": "object",
  1854. "properties": {
  1855. "number_of_shards": {
  1856. "type": "integer"
  1857. },
  1858. "index_name": {
  1859. "type": "string"
  1860. },
  1861. "number_of_replicas": {
  1862. "type": "integer"
  1863. }
  1864. },
  1865. "required": ["number_of_shards", "index_name", "number_of_replicas"]
  1866. },
  1867. "isDeleted": {
  1868. "type": "boolean"
  1869. },
  1870. "name": {
  1871. "type": "string"
  1872. },
  1873. "source": {
  1874. "type": "string"
  1875. },
  1876. "updateTime": {
  1877. "type": "string"
  1878. },
  1879. "userId": {
  1880. "type": "string"
  1881. }
  1882. },
  1883. "required": [
  1884. "connection_config",
  1885. "creationTime",
  1886. "creatorUserId",
  1887. "engine_type",
  1888. "id",
  1889. "index_config",
  1890. "isDeleted",
  1891. "name",
  1892. "source",
  1893. "updateTime",
  1894. "userId"
  1895. ]
  1896. },
  1897. "isAuthorized": {
  1898. "type": "boolean"
  1899. }
  1900. },
  1901. "required": ["isSuccess", "code", "result", "isAuthorized"]
  1902. },
  1903. "example": {
  1904. "isSuccess": true,
  1905. "code": 1,
  1906. "result": {
  1907. "connection_config": {
  1908. "addr": "http://es.shalu.com",
  1909. "version": "8.10.4",
  1910. "username": "elastic"
  1911. },
  1912. "creationTime": "2026-06-08 21:58:07",
  1913. "creatorUserId": "7F8A2BFE-402D-4499-9BB8-2EF7FFC7B993",
  1914. "engine_type": "elasticsearch",
  1915. "id": "2311f372-21b0-4956-ac1e-61d3c49fa606",
  1916. "index_config": {
  1917. "number_of_shards": 4,
  1918. "index_name": "shalu",
  1919. "number_of_replicas": 1
  1920. },
  1921. "isDeleted": false,
  1922. "name": "Elasticsearch",
  1923. "source": "user",
  1924. "updateTime": "2026-06-08 21:58:07",
  1925. "userId": "7F8A2BFE-402D-4499-9BB8-2EF7FFC7B993"
  1926. },
  1927. "isAuthorized": true
  1928. }
  1929. }
  1930. },
  1931. "headers": {}
  1932. }
  1933. },
  1934. "security": []
  1935. }
  1936. },
  1937. "/api/ai/vector-store/update": {
  1938. "post": {
  1939. "summary": "更新向量存储 ",
  1940. "deprecated": false,
  1941. "description": "",
  1942. "tags": ["vector"],
  1943. "parameters": [
  1944. {
  1945. "name": "Authorization",
  1946. "in": "header",
  1947. "description": "",
  1948. "example": "bpm_client_1520995593147650048",
  1949. "schema": {
  1950. "type": "string"
  1951. }
  1952. }
  1953. ],
  1954. "requestBody": {
  1955. "content": {
  1956. "application/json": {
  1957. "schema": {
  1958. "type": "object",
  1959. "properties": {
  1960. "id": {
  1961. "type": "string"
  1962. },
  1963. "name": {
  1964. "type": "string"
  1965. }
  1966. },
  1967. "required": ["id", "name"]
  1968. },
  1969. "example": {
  1970. "id": "2311f372-21b0-4956-ac1e-61d3c49fa606",
  1971. "name": "Elasticsearch"
  1972. }
  1973. }
  1974. },
  1975. "required": true
  1976. },
  1977. "responses": {
  1978. "200": {
  1979. "description": "",
  1980. "content": {
  1981. "application/json": {
  1982. "schema": {
  1983. "type": "object",
  1984. "properties": {
  1985. "isSuccess": {
  1986. "type": "boolean"
  1987. },
  1988. "code": {
  1989. "type": "integer"
  1990. },
  1991. "isAuthorized": {
  1992. "type": "boolean"
  1993. }
  1994. },
  1995. "required": ["isSuccess", "code", "isAuthorized"]
  1996. },
  1997. "example": {
  1998. "isSuccess": true,
  1999. "code": 1,
  2000. "isAuthorized": true
  2001. }
  2002. }
  2003. },
  2004. "headers": {}
  2005. }
  2006. },
  2007. "security": []
  2008. }
  2009. },
  2010. "/api/ai/vector-store/delete": {
  2011. "post": {
  2012. "summary": "删除向量存储",
  2013. "deprecated": false,
  2014. "description": "",
  2015. "tags": ["vector"],
  2016. "parameters": [
  2017. {
  2018. "name": "Authorization",
  2019. "in": "header",
  2020. "description": "",
  2021. "example": "bpm_client_1520995593147650048",
  2022. "schema": {
  2023. "type": "string"
  2024. }
  2025. }
  2026. ],
  2027. "requestBody": {
  2028. "content": {
  2029. "application/json": {
  2030. "schema": {
  2031. "type": "object",
  2032. "properties": {
  2033. "id": {
  2034. "type": "string"
  2035. }
  2036. },
  2037. "required": ["id"]
  2038. },
  2039. "example": {
  2040. "id": "2311f372-21b0-4956-ac1e-61d3c49fa606"
  2041. }
  2042. }
  2043. },
  2044. "required": true
  2045. },
  2046. "responses": {
  2047. "200": {
  2048. "description": "",
  2049. "content": {
  2050. "application/json": {
  2051. "schema": {
  2052. "type": "object",
  2053. "properties": {
  2054. "isSuccess": {
  2055. "type": "boolean"
  2056. },
  2057. "code": {
  2058. "type": "integer"
  2059. },
  2060. "isAuthorized": {
  2061. "type": "boolean"
  2062. }
  2063. },
  2064. "required": ["isSuccess", "code", "isAuthorized"]
  2065. },
  2066. "example": {
  2067. "isSuccess": true,
  2068. "code": 1,
  2069. "isAuthorized": true
  2070. }
  2071. }
  2072. },
  2073. "headers": {}
  2074. }
  2075. },
  2076. "security": []
  2077. }
  2078. },
  2079. "/api/ai/vector-store/connect_test_config": {
  2080. "post": {
  2081. "summary": "使用原始凭据测试连接",
  2082. "deprecated": false,
  2083. "description": "",
  2084. "tags": ["vector"],
  2085. "parameters": [
  2086. {
  2087. "name": "Authorization",
  2088. "in": "header",
  2089. "description": "",
  2090. "example": "bpm_client_1520995593147650048",
  2091. "schema": {
  2092. "type": "string"
  2093. }
  2094. }
  2095. ],
  2096. "requestBody": {
  2097. "content": {
  2098. "application/json": {
  2099. "schema": {
  2100. "type": "object",
  2101. "properties": {
  2102. "engine_type": {
  2103. "type": "string"
  2104. },
  2105. "connection_config": {
  2106. "type": "object",
  2107. "properties": {
  2108. "addr": {
  2109. "type": "string"
  2110. },
  2111. "username": {
  2112. "type": "string"
  2113. },
  2114. "password": {
  2115. "type": "string"
  2116. }
  2117. },
  2118. "required": ["addr", "username", "password"]
  2119. }
  2120. },
  2121. "required": ["engine_type", "connection_config"]
  2122. },
  2123. "example": {
  2124. "engine_type": "elasticsearch",
  2125. "connection_config": {
  2126. "addr": "http://es.shalu.com",
  2127. "username": "elastic",
  2128. "password": ""
  2129. }
  2130. }
  2131. }
  2132. },
  2133. "required": true
  2134. },
  2135. "responses": {
  2136. "200": {
  2137. "description": "",
  2138. "content": {
  2139. "application/json": {
  2140. "schema": {
  2141. "type": "object",
  2142. "properties": {
  2143. "isSuccess": {
  2144. "type": "boolean"
  2145. },
  2146. "code": {
  2147. "type": "integer"
  2148. },
  2149. "result": {
  2150. "type": "object",
  2151. "properties": {
  2152. "version": {
  2153. "type": "string"
  2154. }
  2155. },
  2156. "required": ["version"]
  2157. },
  2158. "isAuthorized": {
  2159. "type": "boolean"
  2160. }
  2161. },
  2162. "required": ["isSuccess", "code", "result", "isAuthorized"]
  2163. },
  2164. "example": {
  2165. "isSuccess": true,
  2166. "code": 1,
  2167. "result": {
  2168. "version": "8.10.4"
  2169. },
  2170. "isAuthorized": true
  2171. }
  2172. }
  2173. },
  2174. "headers": {}
  2175. }
  2176. },
  2177. "security": []
  2178. }
  2179. },
  2180. "/api/ai/vector-store/connect_test_id": {
  2181. "post": {
  2182. "summary": "测试已保存或环境变量存储的连接",
  2183. "deprecated": false,
  2184. "description": "",
  2185. "tags": ["vector"],
  2186. "parameters": [
  2187. {
  2188. "name": "Authorization",
  2189. "in": "header",
  2190. "description": "",
  2191. "example": "bpm_client_1520995593147650048",
  2192. "schema": {
  2193. "type": "string"
  2194. }
  2195. }
  2196. ],
  2197. "requestBody": {
  2198. "content": {
  2199. "application/json": {
  2200. "schema": {
  2201. "type": "object",
  2202. "properties": {
  2203. "id": {
  2204. "type": "string"
  2205. }
  2206. },
  2207. "required": ["id"]
  2208. },
  2209. "example": {
  2210. "id": "aca5124a-171e-4edb-abe7-181733258d59"
  2211. }
  2212. }
  2213. },
  2214. "required": true
  2215. },
  2216. "responses": {
  2217. "200": {
  2218. "description": "",
  2219. "content": {
  2220. "application/json": {
  2221. "schema": {
  2222. "type": "object",
  2223. "properties": {
  2224. "isSuccess": {
  2225. "type": "boolean"
  2226. },
  2227. "code": {
  2228. "type": "integer"
  2229. },
  2230. "result": {
  2231. "type": "object",
  2232. "properties": {
  2233. "version": {
  2234. "type": "string"
  2235. }
  2236. },
  2237. "required": ["version"]
  2238. },
  2239. "isAuthorized": {
  2240. "type": "boolean"
  2241. }
  2242. },
  2243. "required": ["isSuccess", "code", "result", "isAuthorized"]
  2244. },
  2245. "example": {
  2246. "isSuccess": true,
  2247. "code": 1,
  2248. "result": {
  2249. "version": "8.10.4"
  2250. },
  2251. "isAuthorized": true
  2252. }
  2253. }
  2254. },
  2255. "headers": {}
  2256. }
  2257. },
  2258. "security": []
  2259. }
  2260. }
  2261. },
  2262. "components": {
  2263. "schemas": {
  2264. "AgentNode": {
  2265. "type": "object",
  2266. "properties": {
  2267. "appAgentId": {
  2268. "type": "string",
  2269. "format": "uuid"
  2270. },
  2271. "creationTime": {
  2272. "type": "string",
  2273. "format": "date-time"
  2274. },
  2275. "creatorUserId": {
  2276. "type": "string",
  2277. "format": "uuid"
  2278. },
  2279. "data": {
  2280. "$ref": "#/components/schemas/NodeData"
  2281. },
  2282. "height": {
  2283. "type": "integer"
  2284. },
  2285. "id": {
  2286. "type": "string",
  2287. "format": "uuid"
  2288. },
  2289. "isDeleted": {
  2290. "type": "boolean"
  2291. },
  2292. "position": {
  2293. "type": "object",
  2294. "properties": {
  2295. "x": {
  2296. "type": "integer"
  2297. },
  2298. "y": {
  2299. "type": "integer"
  2300. }
  2301. },
  2302. "required": ["x", "y"]
  2303. },
  2304. "selected": {
  2305. "type": "boolean"
  2306. },
  2307. "type": {
  2308. "type": "string",
  2309. "enum": ["custom", "start", "end", "condition", "task", "http-request"]
  2310. },
  2311. "updateTime": {
  2312. "type": "string",
  2313. "format": "date-time"
  2314. },
  2315. "width": {
  2316. "type": "integer"
  2317. },
  2318. "zIndex": {
  2319. "type": "integer"
  2320. }
  2321. },
  2322. "required": [
  2323. "appAgentId",
  2324. "creationTime",
  2325. "creatorUserId",
  2326. "data",
  2327. "id",
  2328. "position",
  2329. "type"
  2330. ]
  2331. },
  2332. "NodeData": {
  2333. "type": "object",
  2334. "properties": {
  2335. "outputs": {
  2336. "type": "array",
  2337. "items": {
  2338. "type": "object",
  2339. "properties": {
  2340. "name": {
  2341. "type": "string"
  2342. },
  2343. "describe": {
  2344. "type": "string"
  2345. },
  2346. "type": {
  2347. "type": "string",
  2348. "enum": ["string", "number", "boolean", "object", "array"]
  2349. }
  2350. },
  2351. "required": ["name", "describe", "type"]
  2352. }
  2353. },
  2354. "output_can_alter": {
  2355. "type": "boolean"
  2356. },
  2357. "variables": {
  2358. "type": "array",
  2359. "items": {
  2360. "type": "string"
  2361. }
  2362. },
  2363. "method": {
  2364. "type": "string",
  2365. "enum": ["get", "post", "put", "delete", "patch", "head", "options"]
  2366. },
  2367. "ssl_verify": {
  2368. "type": "boolean"
  2369. },
  2370. "isInIteration": {
  2371. "type": "boolean"
  2372. },
  2373. "default_value": {
  2374. "type": "array",
  2375. "items": {
  2376. "type": "string"
  2377. }
  2378. },
  2379. "body": {
  2380. "$ref": "#/components/schemas/RequestBody"
  2381. },
  2382. "params": {
  2383. "type": "array",
  2384. "items": {
  2385. "type": "string"
  2386. }
  2387. },
  2388. "title": {
  2389. "type": "string"
  2390. },
  2391. "type": {
  2392. "type": "string",
  2393. "enum": ["http-request", "condition", "task"]
  2394. },
  2395. "error_strategy": {
  2396. "type": "string",
  2397. "enum": ["none", "retry", "abort", "continue"]
  2398. },
  2399. "retry_config": {
  2400. "type": "object",
  2401. "properties": {
  2402. "max_retries": {
  2403. "type": "integer",
  2404. "minimum": 0,
  2405. "maximum": 10
  2406. },
  2407. "retry_enabled": {
  2408. "type": "boolean"
  2409. },
  2410. "retry_interval": {
  2411. "type": "integer",
  2412. "minimum": 0,
  2413. "maximum": 5000
  2414. }
  2415. },
  2416. "required": ["max_retries", "retry_enabled", "retry_interval"]
  2417. },
  2418. "url": {
  2419. "type": "string",
  2420. "format": "uri"
  2421. },
  2422. "authorization": {
  2423. "type": "object",
  2424. "properties": {
  2425. "type": {
  2426. "type": "string",
  2427. "enum": ["none", "bearer", "basic", "api-key"]
  2428. },
  2429. "config": {
  2430. "type": "object",
  2431. "properties": {
  2432. "api_key": {
  2433. "type": "string"
  2434. },
  2435. "header": {
  2436. "type": "string"
  2437. },
  2438. "type": {
  2439. "type": "string"
  2440. }
  2441. }
  2442. }
  2443. },
  2444. "required": ["type", "config"]
  2445. },
  2446. "timeout_config": {
  2447. "type": "object",
  2448. "properties": {
  2449. "max_write_timeout": {
  2450. "type": "integer",
  2451. "minimum": 0
  2452. },
  2453. "max_read_timeout": {
  2454. "type": "integer",
  2455. "minimum": 0
  2456. },
  2457. "max_connect_timeout": {
  2458. "type": "integer",
  2459. "minimum": 0
  2460. }
  2461. },
  2462. "required": ["max_write_timeout", "max_read_timeout", "max_connect_timeout"]
  2463. },
  2464. "heads": {
  2465. "type": "array",
  2466. "items": {
  2467. "$ref": "#/components/schemas/HttpHeader"
  2468. }
  2469. },
  2470. "selected": {
  2471. "type": "boolean"
  2472. },
  2473. "desc": {
  2474. "type": "string"
  2475. },
  2476. "isInLoop": {
  2477. "type": "boolean"
  2478. }
  2479. },
  2480. "required": ["outputs", "method", "title", "type", "url"]
  2481. },
  2482. "RequestBody": {
  2483. "type": "object",
  2484. "properties": {
  2485. "data": {
  2486. "type": "array",
  2487. "items": {
  2488. "$ref": "#/components/schemas/RequestDataItem"
  2489. }
  2490. },
  2491. "type": {
  2492. "type": "string",
  2493. "enum": ["json", "form-data", "x-www-form-urlencoded", "raw", "binary"]
  2494. }
  2495. },
  2496. "required": ["data", "type"]
  2497. },
  2498. "RequestDataItem": {
  2499. "type": "object",
  2500. "properties": {
  2501. "type": {
  2502. "type": "string",
  2503. "enum": ["text", "file", "json"]
  2504. },
  2505. "value": {
  2506. "type": "string"
  2507. },
  2508. "key": {
  2509. "type": "string"
  2510. }
  2511. },
  2512. "required": ["type", "value"]
  2513. },
  2514. "HttpHeader": {
  2515. "type": "object",
  2516. "properties": {
  2517. "name": {
  2518. "type": "string"
  2519. },
  2520. "value": {
  2521. "type": "string"
  2522. }
  2523. },
  2524. "required": ["name", "value"]
  2525. }
  2526. },
  2527. "securitySchemes": {
  2528. "ApiKeyAuth": {
  2529. "type": "apiKey",
  2530. "in": "header",
  2531. "name": "Authorization"
  2532. }
  2533. }
  2534. },
  2535. "security": [
  2536. {
  2537. "ApiKeyAuth": []
  2538. }
  2539. ]
  2540. }