openapi.yaml 30 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166
  1. openapi: 3.1.0
  2. info:
  3. title: FastAPI - Swagger UI
  4. version: 1.0.0
  5. paths:
  6. /agent/job:
  7. post:
  8. tags:
  9. - agent job interface
  10. summary: Submit Job
  11. operationId: submit_job_agent_job_post
  12. requestBody:
  13. content:
  14. application/json:
  15. schema:
  16. $ref: '#/components/schemas/BasicRequest'
  17. required: true
  18. responses:
  19. '200':
  20. description: Successful Response
  21. content:
  22. application/json:
  23. schema:
  24. $ref: '#/components/schemas/StandardResponse'
  25. '422':
  26. description: Validation Error
  27. content:
  28. application/json:
  29. schema:
  30. $ref: '#/components/schemas/HTTPValidationError'
  31. /agent/queue:
  32. post:
  33. tags:
  34. - agent job interface
  35. summary: Submit Queue
  36. operationId: submit_queue_agent_queue_post
  37. requestBody:
  38. content:
  39. application/json:
  40. schema:
  41. $ref: '#/components/schemas/BasicRequest'
  42. required: true
  43. responses:
  44. '200':
  45. description: Successful Response
  46. content:
  47. application/json:
  48. schema:
  49. $ref: '#/components/schemas/StandardResponse'
  50. '422':
  51. description: Validation Error
  52. content:
  53. application/json:
  54. schema:
  55. $ref: '#/components/schemas/HTTPValidationError'
  56. /file/upload/{file_type}/{job_id}:
  57. post:
  58. tags:
  59. - agent job interface
  60. summary: Upload File
  61. operationId: upload_file_file_upload__file_type___job_id__post
  62. parameters:
  63. - name: file_type
  64. in: path
  65. required: true
  66. schema:
  67. type: string
  68. title: File Type
  69. - name: job_id
  70. in: path
  71. required: true
  72. schema:
  73. type: integer
  74. title: Job Id
  75. requestBody:
  76. required: true
  77. content:
  78. multipart/form-data:
  79. schema:
  80. $ref: '#/components/schemas/Body_upload_file_file_upload__file_type___job_id__post'
  81. responses:
  82. '200':
  83. description: Successful Response
  84. content:
  85. application/json:
  86. schema:
  87. $ref: '#/components/schemas/StandardResponse'
  88. '422':
  89. description: Validation Error
  90. content:
  91. application/json:
  92. schema:
  93. $ref: '#/components/schemas/HTTPValidationError'
  94. /file/browse:
  95. post:
  96. tags:
  97. - agent job interface
  98. summary: Browser File
  99. operationId: browser_file_file_browse_post
  100. requestBody:
  101. content:
  102. application/json:
  103. schema:
  104. $ref: '#/components/schemas/BasicRequest'
  105. required: true
  106. responses:
  107. '200':
  108. description: Successful Response
  109. content:
  110. application/json:
  111. schema:
  112. $ref: '#/components/schemas/StandardResponse'
  113. '422':
  114. description: Validation Error
  115. content:
  116. application/json:
  117. schema:
  118. $ref: '#/components/schemas/HTTPValidationError'
  119. /file/download/{job_id}:
  120. get:
  121. tags:
  122. - agent job interface
  123. summary: Download File
  124. operationId: download_file_file_download__job_id__get
  125. parameters:
  126. - name: job_id
  127. in: path
  128. required: true
  129. schema:
  130. type: integer
  131. title: Job Id
  132. - name: path
  133. in: query
  134. required: false
  135. schema:
  136. type: string
  137. default: path
  138. title: Path
  139. responses:
  140. '200':
  141. description: Successful Response
  142. content:
  143. application/json:
  144. schema: {}
  145. '422':
  146. description: Validation Error
  147. content:
  148. application/json:
  149. schema:
  150. $ref: '#/components/schemas/HTTPValidationError'
  151. /file/view/{job_id}:
  152. get:
  153. tags:
  154. - agent job interface
  155. summary: View File
  156. operationId: view_file_file_view__job_id__get
  157. parameters:
  158. - name: job_id
  159. in: path
  160. required: true
  161. schema:
  162. type: integer
  163. title: Job Id
  164. - name: path
  165. in: query
  166. required: false
  167. schema:
  168. type: string
  169. default: path
  170. title: Path
  171. responses:
  172. '200':
  173. description: Successful Response
  174. content:
  175. application/json:
  176. schema:
  177. $ref: '#/components/schemas/StandardResponse'
  178. '422':
  179. description: Validation Error
  180. content:
  181. application/json:
  182. schema:
  183. $ref: '#/components/schemas/HTTPValidationError'
  184. /user/session:
  185. post:
  186. tags:
  187. - agent job interface
  188. summary: Register
  189. operationId: register_user_session_post
  190. requestBody:
  191. content:
  192. application/json:
  193. schema:
  194. $ref: '#/components/schemas/BasicRequest'
  195. required: true
  196. responses:
  197. '200':
  198. description: Successful Response
  199. content:
  200. application/json:
  201. schema:
  202. $ref: '#/components/schemas/StandardResponse'
  203. '422':
  204. description: Validation Error
  205. content:
  206. application/json:
  207. schema:
  208. $ref: '#/components/schemas/HTTPValidationError'
  209. /user/logout/{session_id}:
  210. get:
  211. tags:
  212. - agent job interface
  213. summary: Logout
  214. operationId: logout_user_logout__session_id__get
  215. parameters:
  216. - name: session_id
  217. in: path
  218. required: true
  219. schema:
  220. type: string
  221. title: Session Id
  222. responses:
  223. '200':
  224. description: Successful Response
  225. content:
  226. application/json:
  227. schema:
  228. $ref: '#/components/schemas/StandardResponse'
  229. '422':
  230. description: Validation Error
  231. content:
  232. application/json:
  233. schema:
  234. $ref: '#/components/schemas/HTTPValidationError'
  235. /user/signin:
  236. post:
  237. tags:
  238. - agent job interface
  239. summary: Signin
  240. operationId: signin_user_signin_post
  241. requestBody:
  242. content:
  243. application/json:
  244. schema:
  245. $ref: '#/components/schemas/BasicRequest'
  246. required: true
  247. responses:
  248. '200':
  249. description: Successful Response
  250. content:
  251. application/json:
  252. schema:
  253. $ref: '#/components/schemas/StandardResponse'
  254. '422':
  255. description: Validation Error
  256. content:
  257. application/json:
  258. schema:
  259. $ref: '#/components/schemas/HTTPValidationError'
  260. /user/roles:
  261. get:
  262. tags:
  263. - agent job interface
  264. summary: Get Roles Endpoint
  265. operationId: get_roles_endpoint_user_roles_get
  266. responses:
  267. '200':
  268. description: Successful Response
  269. content:
  270. application/json:
  271. schema:
  272. $ref: '#/components/schemas/StandardResponse'
  273. post:
  274. tags:
  275. - agent job interface
  276. summary: Create Role With Permissions Endpoint
  277. operationId: create_role_with_permissions_endpoint_user_roles_post
  278. requestBody:
  279. content:
  280. application/json:
  281. schema:
  282. $ref: '#/components/schemas/RoleCreateWithPermissionsRequest'
  283. required: true
  284. responses:
  285. '200':
  286. description: Successful Response
  287. content:
  288. application/json:
  289. schema:
  290. $ref: '#/components/schemas/StandardResponse'
  291. '422':
  292. description: Validation Error
  293. content:
  294. application/json:
  295. schema:
  296. $ref: '#/components/schemas/HTTPValidationError'
  297. /user/permissions:
  298. get:
  299. tags:
  300. - agent job interface
  301. summary: Get Permissions Endpoint
  302. operationId: get_permissions_endpoint_user_permissions_get
  303. responses:
  304. '200':
  305. description: Successful Response
  306. content:
  307. application/json:
  308. schema:
  309. $ref: '#/components/schemas/StandardResponse'
  310. post:
  311. tags:
  312. - agent job interface
  313. summary: Create Permission Endpoint
  314. operationId: create_permission_endpoint_user_permissions_post
  315. requestBody:
  316. content:
  317. application/json:
  318. schema:
  319. $ref: '#/components/schemas/PermissionCreateRequest'
  320. required: true
  321. responses:
  322. '200':
  323. description: Successful Response
  324. content:
  325. application/json:
  326. schema:
  327. $ref: '#/components/schemas/StandardResponse'
  328. '422':
  329. description: Validation Error
  330. content:
  331. application/json:
  332. schema:
  333. $ref: '#/components/schemas/HTTPValidationError'
  334. /user/users/roles:
  335. post:
  336. tags:
  337. - agent job interface
  338. summary: Assign Roles To User Endpoint
  339. operationId: assign_roles_to_user_endpoint_user_users_roles_post
  340. requestBody:
  341. content:
  342. application/json:
  343. schema:
  344. $ref: '#/components/schemas/UserRoleAssignmentRequest'
  345. required: true
  346. responses:
  347. '200':
  348. description: Successful Response
  349. content:
  350. application/json:
  351. schema:
  352. $ref: '#/components/schemas/StandardResponse'
  353. '422':
  354. description: Validation Error
  355. content:
  356. application/json:
  357. schema:
  358. $ref: '#/components/schemas/HTTPValidationError'
  359. /user/users:
  360. get:
  361. tags:
  362. - agent job interface
  363. summary: Get Users Endpoint
  364. operationId: get_users_endpoint_user_users_get
  365. parameters:
  366. - name: userName
  367. in: query
  368. required: false
  369. schema:
  370. anyOf:
  371. - type: string
  372. - type: 'null'
  373. description: "\u7528\u6237\u540D\uFF0C\u7528\u4E8E\u6A21\u7CCA\u67E5\u8BE2"
  374. title: Username
  375. description: "\u7528\u6237\u540D\uFF0C\u7528\u4E8E\u6A21\u7CCA\u67E5\u8BE2"
  376. - name: pageNo
  377. in: query
  378. required: false
  379. schema:
  380. type: integer
  381. minimum: 1
  382. description: "\u9875\u7801\uFF0C\u4ECE1\u5F00\u59CB"
  383. default: 1
  384. title: Pageno
  385. description: "\u9875\u7801\uFF0C\u4ECE1\u5F00\u59CB"
  386. - name: pageSize
  387. in: query
  388. required: false
  389. schema:
  390. type: integer
  391. maximum: 100
  392. minimum: 1
  393. description: "\u6BCF\u9875\u6570\u91CF\uFF0C\u6700\u5927100"
  394. default: 10
  395. title: Pagesize
  396. description: "\u6BCF\u9875\u6570\u91CF\uFF0C\u6700\u5927100"
  397. responses:
  398. '200':
  399. description: Successful Response
  400. content:
  401. application/json:
  402. schema:
  403. $ref: '#/components/schemas/StandardResponse'
  404. '422':
  405. description: Validation Error
  406. content:
  407. application/json:
  408. schema:
  409. $ref: '#/components/schemas/HTTPValidationError'
  410. /kb/summary:
  411. post:
  412. tags:
  413. - knowledge build interface
  414. summary: Summary Func
  415. operationId: summary_func_kb_summary_post
  416. requestBody:
  417. content:
  418. application/json:
  419. schema:
  420. $ref: '#/components/schemas/BasicRequest'
  421. required: true
  422. responses:
  423. '200':
  424. description: Successful Response
  425. content:
  426. application/json:
  427. schema:
  428. $ref: '#/components/schemas/StandardResponse'
  429. '422':
  430. description: Validation Error
  431. content:
  432. application/json:
  433. schema:
  434. $ref: '#/components/schemas/HTTPValidationError'
  435. /kb/schemas:
  436. post:
  437. tags:
  438. - knowledge build interface
  439. summary: Schemas Func
  440. operationId: schemas_func_kb_schemas_post
  441. requestBody:
  442. content:
  443. application/json:
  444. schema:
  445. $ref: '#/components/schemas/BasicRequest'
  446. required: true
  447. responses:
  448. '200':
  449. description: Successful Response
  450. content:
  451. application/json:
  452. schema:
  453. $ref: '#/components/schemas/StandardResponse'
  454. '422':
  455. description: Validation Error
  456. content:
  457. application/json:
  458. schema:
  459. $ref: '#/components/schemas/HTTPValidationError'
  460. /kb/nodes:
  461. post:
  462. tags:
  463. - knowledge build interface
  464. summary: Nodes Func
  465. operationId: nodes_func_kb_nodes_post
  466. requestBody:
  467. content:
  468. application/json:
  469. schema:
  470. $ref: '#/components/schemas/BasicRequest'
  471. required: true
  472. responses:
  473. '200':
  474. description: Successful Response
  475. content:
  476. application/json:
  477. schema:
  478. $ref: '#/components/schemas/StandardResponse'
  479. '422':
  480. description: Validation Error
  481. content:
  482. application/json:
  483. schema:
  484. $ref: '#/components/schemas/HTTPValidationError'
  485. /knowledge-base/:
  486. post:
  487. tags:
  488. - knowledge base interface
  489. summary: Create Knowledge Base
  490. operationId: create_knowledge_base_knowledge_base__post
  491. requestBody:
  492. required: true
  493. content:
  494. application/json:
  495. schema:
  496. $ref: '#/components/schemas/KnowledgeBaseCreate'
  497. responses:
  498. '200':
  499. description: Successful Response
  500. content:
  501. application/json:
  502. schema:
  503. $ref: '#/components/schemas/ResponseModel'
  504. '422':
  505. description: Validation Error
  506. content:
  507. application/json:
  508. schema:
  509. $ref: '#/components/schemas/HTTPValidationError'
  510. get:
  511. tags:
  512. - knowledge base interface
  513. summary: List Knowledge Bases
  514. operationId: list_knowledge_bases_knowledge_base__get
  515. parameters:
  516. - name: pageNo
  517. in: query
  518. required: false
  519. schema:
  520. type: integer
  521. default: 1
  522. title: Pageno
  523. - name: pageSize
  524. in: query
  525. required: false
  526. schema:
  527. type: integer
  528. default: 10
  529. title: Pagesize
  530. - name: name
  531. in: query
  532. required: false
  533. schema:
  534. anyOf:
  535. - type: string
  536. - type: 'null'
  537. title: Name
  538. responses:
  539. '200':
  540. description: Successful Response
  541. content:
  542. application/json:
  543. schema:
  544. $ref: '#/components/schemas/ResponseModel'
  545. '422':
  546. description: Validation Error
  547. content:
  548. application/json:
  549. schema:
  550. $ref: '#/components/schemas/HTTPValidationError'
  551. /knowledge-base/{kb_id}:
  552. put:
  553. tags:
  554. - knowledge base interface
  555. summary: Update Knowledge Base
  556. operationId: update_knowledge_base_knowledge_base__kb_id__put
  557. parameters:
  558. - name: kb_id
  559. in: path
  560. required: true
  561. schema:
  562. type: integer
  563. title: Kb Id
  564. requestBody:
  565. required: true
  566. content:
  567. application/json:
  568. schema:
  569. $ref: '#/components/schemas/KnowledgeBaseUpdate'
  570. responses:
  571. '200':
  572. description: Successful Response
  573. content:
  574. application/json:
  575. schema:
  576. $ref: '#/components/schemas/ResponseModel'
  577. '422':
  578. description: Validation Error
  579. content:
  580. application/json:
  581. schema:
  582. $ref: '#/components/schemas/HTTPValidationError'
  583. delete:
  584. tags:
  585. - knowledge base interface
  586. summary: Delete Knowledge Base
  587. operationId: delete_knowledge_base_knowledge_base__kb_id__delete
  588. parameters:
  589. - name: kb_id
  590. in: path
  591. required: true
  592. schema:
  593. type: integer
  594. title: Kb Id
  595. responses:
  596. '200':
  597. description: Successful Response
  598. content:
  599. application/json:
  600. schema:
  601. $ref: '#/components/schemas/ResponseModel'
  602. '422':
  603. description: Validation Error
  604. content:
  605. application/json:
  606. schema:
  607. $ref: '#/components/schemas/HTTPValidationError'
  608. get:
  609. tags:
  610. - knowledge base interface
  611. summary: Get Knowledge Base
  612. operationId: get_knowledge_base_knowledge_base__kb_id__get
  613. parameters:
  614. - name: kb_id
  615. in: path
  616. required: true
  617. schema:
  618. type: integer
  619. title: Kb Id
  620. responses:
  621. '200':
  622. description: Successful Response
  623. content:
  624. application/json:
  625. schema:
  626. $ref: '#/components/schemas/ResponseModel'
  627. '422':
  628. description: Validation Error
  629. content:
  630. application/json:
  631. schema:
  632. $ref: '#/components/schemas/HTTPValidationError'
  633. /knowledge-base/name/{name}:
  634. get:
  635. tags:
  636. - knowledge base interface
  637. summary: Get Knowledge Base By Name
  638. operationId: get_knowledge_base_by_name_knowledge_base_name__name__get
  639. parameters:
  640. - name: name
  641. in: path
  642. required: true
  643. schema:
  644. type: string
  645. title: Name
  646. responses:
  647. '200':
  648. description: Successful Response
  649. content:
  650. application/json:
  651. schema:
  652. $ref: '#/components/schemas/ResponseModel'
  653. '422':
  654. description: Validation Error
  655. content:
  656. application/json:
  657. schema:
  658. $ref: '#/components/schemas/HTTPValidationError'
  659. /knowledge-base/{kb_id}/files/:
  660. post:
  661. tags:
  662. - knowledge base interface
  663. summary: Upload Files
  664. operationId: upload_files_knowledge_base__kb_id__files__post
  665. parameters:
  666. - name: kb_id
  667. in: path
  668. required: true
  669. schema:
  670. type: integer
  671. title: Kb Id
  672. requestBody:
  673. required: true
  674. content:
  675. multipart/form-data:
  676. schema:
  677. $ref: '#/components/schemas/Body_upload_files_knowledge_base__kb_id__files__post'
  678. responses:
  679. '200':
  680. description: Successful Response
  681. content:
  682. application/json:
  683. schema:
  684. $ref: '#/components/schemas/ResponseModel'
  685. '422':
  686. description: Validation Error
  687. content:
  688. application/json:
  689. schema:
  690. $ref: '#/components/schemas/HTTPValidationError'
  691. get:
  692. tags:
  693. - knowledge base interface
  694. summary: List Files
  695. operationId: list_files_knowledge_base__kb_id__files__get
  696. parameters:
  697. - name: kb_id
  698. in: path
  699. required: true
  700. schema:
  701. type: integer
  702. title: Kb Id
  703. - name: pageNo
  704. in: query
  705. required: false
  706. schema:
  707. type: integer
  708. default: 1
  709. title: Pageno
  710. - name: pageSize
  711. in: query
  712. required: false
  713. schema:
  714. type: integer
  715. default: 10
  716. title: Pagesize
  717. - name: file_name
  718. in: query
  719. required: false
  720. schema:
  721. anyOf:
  722. - type: string
  723. - type: 'null'
  724. title: File Name
  725. responses:
  726. '200':
  727. description: Successful Response
  728. content:
  729. application/json:
  730. schema:
  731. $ref: '#/components/schemas/ResponseModel'
  732. '422':
  733. description: Validation Error
  734. content:
  735. application/json:
  736. schema:
  737. $ref: '#/components/schemas/HTTPValidationError'
  738. /knowledge-base/{kb_id}/files/search/:
  739. get:
  740. tags:
  741. - knowledge base interface
  742. summary: Search Files
  743. operationId: search_files_knowledge_base__kb_id__files_search__get
  744. parameters:
  745. - name: kb_id
  746. in: path
  747. required: true
  748. schema:
  749. type: integer
  750. title: Kb Id
  751. - name: file_name
  752. in: query
  753. required: true
  754. schema:
  755. type: string
  756. title: File Name
  757. responses:
  758. '200':
  759. description: Successful Response
  760. content:
  761. application/json:
  762. schema:
  763. $ref: '#/components/schemas/ResponseModel'
  764. '422':
  765. description: Validation Error
  766. content:
  767. application/json:
  768. schema:
  769. $ref: '#/components/schemas/HTTPValidationError'
  770. /files/{file_id}/download:
  771. get:
  772. tags:
  773. - knowledge base interface
  774. summary: Download File
  775. operationId: download_file_files__file_id__download_get
  776. parameters:
  777. - name: file_id
  778. in: path
  779. required: true
  780. schema:
  781. type: integer
  782. title: File Id
  783. responses:
  784. '200':
  785. description: Successful Response
  786. content:
  787. application/json:
  788. schema: {}
  789. '422':
  790. description: Validation Error
  791. content:
  792. application/json:
  793. schema:
  794. $ref: '#/components/schemas/HTTPValidationError'
  795. /files/{file_id}:
  796. delete:
  797. tags:
  798. - knowledge base interface
  799. summary: Delete File
  800. operationId: delete_file_files__file_id__delete
  801. parameters:
  802. - name: file_id
  803. in: path
  804. required: true
  805. schema:
  806. type: integer
  807. title: File Id
  808. responses:
  809. '200':
  810. description: Successful Response
  811. content:
  812. application/json:
  813. schema:
  814. type: object
  815. additionalProperties: true
  816. title: Response Delete File Files File Id Delete
  817. '422':
  818. description: Validation Error
  819. content:
  820. application/json:
  821. schema:
  822. $ref: '#/components/schemas/HTTPValidationError'
  823. /files/batch-update:
  824. put:
  825. tags:
  826. - knowledge base interface
  827. summary: Batch Update Files
  828. operationId: batch_update_files_files_batch_update_put
  829. requestBody:
  830. content:
  831. application/json:
  832. schema:
  833. $ref: '#/components/schemas/BatchFileUpdate'
  834. required: true
  835. responses:
  836. '200':
  837. description: Successful Response
  838. content:
  839. application/json:
  840. schema:
  841. $ref: '#/components/schemas/ResponseModel'
  842. '422':
  843. description: Validation Error
  844. content:
  845. application/json:
  846. schema:
  847. $ref: '#/components/schemas/HTTPValidationError'
  848. components:
  849. schemas:
  850. BasicRequest:
  851. properties:
  852. action:
  853. type: string
  854. title: Action
  855. id:
  856. type: string
  857. title: Id
  858. params:
  859. items:
  860. $ref: '#/components/schemas/BasicRequestParameter'
  861. type: array
  862. title: Params
  863. type: object
  864. required:
  865. - action
  866. - id
  867. - params
  868. title: BasicRequest
  869. BasicRequestParameter:
  870. properties:
  871. name:
  872. type: string
  873. title: Name
  874. value:
  875. anyOf:
  876. - type: string
  877. - type: integer
  878. - type: number
  879. - type: boolean
  880. - items:
  881. type: string
  882. type: array
  883. - items:
  884. type: integer
  885. type: array
  886. - items:
  887. type: number
  888. type: array
  889. - items:
  890. type: boolean
  891. type: array
  892. title: Value
  893. type: object
  894. required:
  895. - name
  896. - value
  897. title: BasicRequestParameter
  898. BatchFileUpdate:
  899. properties:
  900. files:
  901. items:
  902. $ref: '#/components/schemas/FileUpdate'
  903. type: array
  904. title: Files
  905. type: object
  906. required:
  907. - files
  908. title: BatchFileUpdate
  909. Body_upload_file_file_upload__file_type___job_id__post:
  910. properties:
  911. file:
  912. type: string
  913. format: binary
  914. title: File
  915. type: object
  916. required:
  917. - file
  918. title: Body_upload_file_file_upload__file_type___job_id__post
  919. Body_upload_files_knowledge_base__kb_id__files__post:
  920. properties:
  921. files:
  922. items:
  923. type: string
  924. format: binary
  925. type: array
  926. title: Files
  927. type: object
  928. required:
  929. - files
  930. title: Body_upload_files_knowledge_base__kb_id__files__post
  931. FileUpdate:
  932. properties:
  933. id:
  934. type: integer
  935. title: Id
  936. file_name:
  937. anyOf:
  938. - type: string
  939. - type: 'null'
  940. title: File Name
  941. version:
  942. anyOf:
  943. - type: string
  944. - type: 'null'
  945. title: Version
  946. author:
  947. anyOf:
  948. - type: string
  949. - type: 'null'
  950. title: Author
  951. year:
  952. anyOf:
  953. - type: integer
  954. - type: 'null'
  955. title: Year
  956. page_count:
  957. anyOf:
  958. - type: integer
  959. - type: 'null'
  960. title: Page Count
  961. creator:
  962. anyOf:
  963. - type: string
  964. - type: 'null'
  965. title: Creator
  966. knowledge_type:
  967. anyOf:
  968. - type: string
  969. - type: 'null'
  970. title: Knowledge Type
  971. type: object
  972. required:
  973. - id
  974. title: FileUpdate
  975. HTTPValidationError:
  976. properties:
  977. detail:
  978. items:
  979. $ref: '#/components/schemas/ValidationError'
  980. type: array
  981. title: Detail
  982. type: object
  983. title: HTTPValidationError
  984. KnowledgeBaseCreate:
  985. properties:
  986. name:
  987. type: string
  988. title: Name
  989. description:
  990. anyOf:
  991. - type: string
  992. - type: 'null'
  993. title: Description
  994. tags:
  995. anyOf:
  996. - type: string
  997. - type: 'null'
  998. title: Tags
  999. type: object
  1000. required:
  1001. - name
  1002. title: KnowledgeBaseCreate
  1003. KnowledgeBaseUpdate:
  1004. properties:
  1005. name:
  1006. type: string
  1007. title: Name
  1008. description:
  1009. anyOf:
  1010. - type: string
  1011. - type: 'null'
  1012. title: Description
  1013. tags:
  1014. anyOf:
  1015. - type: string
  1016. - type: 'null'
  1017. title: Tags
  1018. type: object
  1019. required:
  1020. - name
  1021. title: KnowledgeBaseUpdate
  1022. PermissionCreateRequest:
  1023. properties:
  1024. name:
  1025. type: string
  1026. title: Name
  1027. description:
  1028. anyOf:
  1029. - type: string
  1030. - type: 'null'
  1031. title: Description
  1032. menu_name:
  1033. anyOf:
  1034. - type: string
  1035. - type: 'null'
  1036. title: Menu Name
  1037. menu_route:
  1038. anyOf:
  1039. - type: string
  1040. - type: 'null'
  1041. title: Menu Route
  1042. menu_icon:
  1043. anyOf:
  1044. - type: string
  1045. - type: 'null'
  1046. title: Menu Icon
  1047. parent_id:
  1048. anyOf:
  1049. - type: integer
  1050. - type: 'null'
  1051. title: Parent Id
  1052. type: object
  1053. required:
  1054. - name
  1055. title: PermissionCreateRequest
  1056. ResponseModel:
  1057. properties:
  1058. code:
  1059. type: integer
  1060. title: Code
  1061. message:
  1062. type: string
  1063. title: Message
  1064. data:
  1065. anyOf:
  1066. - additionalProperties: true
  1067. type: object
  1068. - items: {}
  1069. type: array
  1070. - type: boolean
  1071. - type: 'null'
  1072. title: Data
  1073. type: object
  1074. required:
  1075. - code
  1076. - message
  1077. - data
  1078. title: ResponseModel
  1079. RoleCreateWithPermissionsRequest:
  1080. properties:
  1081. role_id:
  1082. anyOf:
  1083. - type: integer
  1084. - type: 'null'
  1085. title: Role Id
  1086. name:
  1087. type: string
  1088. title: Name
  1089. description:
  1090. anyOf:
  1091. - type: string
  1092. - type: 'null'
  1093. title: Description
  1094. permission_ids:
  1095. items:
  1096. type: integer
  1097. type: array
  1098. title: Permission Ids
  1099. default: []
  1100. type: object
  1101. required:
  1102. - name
  1103. title: RoleCreateWithPermissionsRequest
  1104. StandardResponse:
  1105. properties:
  1106. code:
  1107. type: integer
  1108. title: Code
  1109. default: 200
  1110. message:
  1111. type: string
  1112. title: Message
  1113. default: success
  1114. meta:
  1115. additionalProperties: true
  1116. type: object
  1117. title: Meta
  1118. default: {}
  1119. records:
  1120. items: {}
  1121. type: array
  1122. title: Records
  1123. default: []
  1124. total:
  1125. anyOf:
  1126. - type: integer
  1127. - type: 'null'
  1128. title: Total
  1129. type: object
  1130. title: StandardResponse
  1131. UserRoleAssignmentRequest:
  1132. properties:
  1133. user_id:
  1134. type: integer
  1135. title: User Id
  1136. role_ids:
  1137. items:
  1138. type: integer
  1139. type: array
  1140. title: Role Ids
  1141. type: object
  1142. required:
  1143. - user_id
  1144. - role_ids
  1145. title: UserRoleAssignmentRequest
  1146. ValidationError:
  1147. properties:
  1148. loc:
  1149. items:
  1150. anyOf:
  1151. - type: string
  1152. - type: integer
  1153. type: array
  1154. title: Location
  1155. msg:
  1156. type: string
  1157. title: Message
  1158. type:
  1159. type: string
  1160. title: Error Type
  1161. type: object
  1162. required:
  1163. - loc
  1164. - msg
  1165. - type
  1166. title: ValidationError