knowledge.ts 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202
  1. export interface ISpace {
  2. context?: any;
  3. desc: string;
  4. docs: string | number;
  5. gmt_created: string;
  6. gmt_modified: string;
  7. id: string | number;
  8. name: string;
  9. owner: string;
  10. vector_type: string;
  11. domain_type: string;
  12. }
  13. export type AddKnowledgeParams = {
  14. name: string;
  15. vector_type: string;
  16. owner: string;
  17. desc: string;
  18. domain_type: string;
  19. };
  20. export type BaseDocumentParams = {
  21. doc_name: string;
  22. content: string;
  23. doc_type: string;
  24. };
  25. export type Embedding = {
  26. chunk_overlap: string | number;
  27. chunk_size: string | number;
  28. model: string;
  29. recall_score: string | number;
  30. recall_type: string;
  31. topk: string;
  32. };
  33. export type Prompt = {
  34. max_token: string | number;
  35. scene: string;
  36. template: string;
  37. };
  38. export type Summary = {
  39. max_iteration: number;
  40. concurrency_limit: number;
  41. };
  42. export type IArguments = {
  43. embedding: Embedding;
  44. prompt: Prompt;
  45. summary: Summary;
  46. };
  47. export type DocumentParams = {
  48. doc_name: string;
  49. source?: string;
  50. content: string;
  51. doc_type: string;
  52. questions?: string[];
  53. };
  54. export type IDocument = {
  55. doc_name: string;
  56. source?: string;
  57. content: string;
  58. doc_type: string;
  59. chunk_size: string | number;
  60. gmt_created: string;
  61. gmt_modified: string;
  62. id: number;
  63. last_sync: string;
  64. result: string;
  65. space: string;
  66. status: string;
  67. vector_ids: string;
  68. questions?: string[];
  69. };
  70. export type IDocumentResponse = {
  71. data: Array<IDocument>;
  72. page: number;
  73. total: number;
  74. };
  75. export type IStrategyParameter = {
  76. param_name: string;
  77. param_type: string;
  78. default_value?: string | number;
  79. description: string;
  80. };
  81. export type IChunkStrategyResponse = {
  82. strategy: string;
  83. name: string;
  84. parameters: Array<IStrategyParameter>;
  85. suffix: Array<string>;
  86. type: Array<string>;
  87. };
  88. export type IStrategyProps = {
  89. chunk_strategy: string;
  90. chunk_size?: number;
  91. chunk_overlap?: number;
  92. };
  93. export type ISyncBatchParameter = {
  94. doc_id: number;
  95. name?: string;
  96. chunk_parameters: IStrategyProps;
  97. };
  98. export type ISyncBatchResponse = {
  99. tasks: Array<number>;
  100. };
  101. export type ChunkListParams = {
  102. document_id?: string | number;
  103. page: number;
  104. page_size: number;
  105. content?: string;
  106. };
  107. export type IChunk = {
  108. content: string;
  109. doc_name: string;
  110. doc_type: string;
  111. document_id: string | number;
  112. gmt_created: string;
  113. gmt_modified: string;
  114. id: string | number;
  115. meta_info: string;
  116. recall_score?: string | number;
  117. };
  118. export type IChunkList = {
  119. data: Array<IChunk>;
  120. page: number;
  121. total: number;
  122. };
  123. export type GraphVisResult = {
  124. nodes: Array<any>;
  125. edges: Array<any>;
  126. };
  127. export type ArgumentsParams = {
  128. argument: string;
  129. };
  130. export type StepChangeParams = {
  131. label: 'forward' | 'back' | 'finish';
  132. spaceName?: string;
  133. docType?: string;
  134. files?: Array<File>;
  135. pace?: number;
  136. };
  137. export type File = {
  138. name: string;
  139. doc_id: number;
  140. status?: string;
  141. };
  142. export type SummaryParams = {
  143. doc_id: number;
  144. model_name: string;
  145. conv_uid: string;
  146. };
  147. export interface SearchDocumentParams {
  148. doc_name?: string;
  149. status?: string;
  150. }
  151. export interface AddYuqueProps {
  152. doc_name: string;
  153. content: string;
  154. doc_token: string;
  155. doc_type: string;
  156. space_name: string;
  157. questions?: string[];
  158. }
  159. export interface RecallTestChunk {
  160. chunk_id: number;
  161. content: string;
  162. metadata: Record<string, any>;
  163. score: number;
  164. }
  165. export interface RecallTestProps {
  166. question: string;
  167. recall_score_threshold?: number;
  168. recall_top_k?: number;
  169. recall_retrievers: string[];
  170. }
  171. export type SpaceConfig = {
  172. storage: IStorage;
  173. };
  174. export type IStorage = Array<{
  175. name: string;
  176. desc: string;
  177. domain_types: Array<{ name: string; desc: string }>;
  178. }>;