datasets.ts 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
  1. import type { Fetcher } from 'swr'
  2. import qs from 'qs'
  3. import { del, get, patch, post, put } from './base'
  4. import type {
  5. CreateDocumentReq,
  6. DataSet,
  7. DataSetListResponse,
  8. DocumentDetailResponse,
  9. DocumentListResponse,
  10. ErrorDocsResponse,
  11. FileIndexingEstimateResponse,
  12. HitTestingRecordsResponse,
  13. HitTestingResponse,
  14. IndexingEstimateParams,
  15. IndexingEstimateResponse,
  16. IndexingStatusBatchResponse,
  17. IndexingStatusResponse,
  18. ProcessRuleResponse,
  19. RelatedAppResponse,
  20. SegmentDetailModel,
  21. SegmentUpdator,
  22. SegmentsQuery,
  23. SegmentsResponse,
  24. createDocumentResponse,
  25. } from '@/models/datasets'
  26. import type { CommonResponse, DataSourceNotionWorkspace } from '@/models/common'
  27. import type {
  28. ApikeysListResponse,
  29. CreateApiKeyResponse,
  30. } from '@/models/app'
  31. import type { RetrievalConfig } from '@/types/app'
  32. // apis for documents in a dataset
  33. type CommonDocReq = {
  34. datasetId: string
  35. documentId: string
  36. }
  37. type BatchReq = {
  38. datasetId: string
  39. batchId: string
  40. }
  41. export type SortType = 'created_at' | 'hit_count' | '-created_at' | '-hit_count'
  42. export type MetadataType = 'all' | 'only' | 'without'
  43. export const fetchDatasetDetail: Fetcher<DataSet, string> = (datasetId: string) => {
  44. return get<DataSet>(`/datasets/${datasetId}`)
  45. }
  46. export const updateDatasetSetting: Fetcher<DataSet, {
  47. datasetId: string
  48. body: Partial<Pick<DataSet,
  49. 'name' | 'description' | 'permission' | 'indexing_technique' | 'retrieval_model' | 'embedding_model' | 'embedding_model_provider'
  50. >>
  51. }> = ({ datasetId, body }) => {
  52. return patch<DataSet>(`/datasets/${datasetId}`, { body })
  53. }
  54. export const fetchDatasetRelatedApps: Fetcher<RelatedAppResponse, string> = (datasetId: string) => {
  55. return get<RelatedAppResponse>(`/datasets/${datasetId}/related-apps`)
  56. }
  57. export const fetchDatasets: Fetcher<DataSetListResponse, { url: string; params: { page: number; ids?: string[]; limit?: number } }> = ({ url, params }) => {
  58. const urlParams = qs.stringify(params, { indices: false })
  59. return get<DataSetListResponse>(`${url}?${urlParams}`)
  60. }
  61. export const createEmptyDataset: Fetcher<DataSet, { name: string }> = ({ name }) => {
  62. return post<DataSet>('/datasets', { body: { name } })
  63. }
  64. export const deleteDataset: Fetcher<DataSet, string> = (datasetID) => {
  65. return del<DataSet>(`/datasets/${datasetID}`)
  66. }
  67. export const fetchDefaultProcessRule: Fetcher<ProcessRuleResponse, { url: string }> = ({ url }) => {
  68. return get<ProcessRuleResponse>(url)
  69. }
  70. export const fetchProcessRule: Fetcher<ProcessRuleResponse, { params: { documentId: string } }> = ({ params: { documentId } }) => {
  71. return get<ProcessRuleResponse>('/datasets/process-rule', { params: { document_id: documentId } })
  72. }
  73. export const fetchDocuments: Fetcher<DocumentListResponse, { datasetId: string; params: { keyword: string; page: number; limit: number; sort?: SortType } }> = ({ datasetId, params }) => {
  74. return get<DocumentListResponse>(`/datasets/${datasetId}/documents`, { params })
  75. }
  76. export const createFirstDocument: Fetcher<createDocumentResponse, { body: CreateDocumentReq }> = ({ body }) => {
  77. return post<createDocumentResponse>('/datasets/init', { body })
  78. }
  79. export const createDocument: Fetcher<createDocumentResponse, { datasetId: string; body: CreateDocumentReq }> = ({ datasetId, body }) => {
  80. return post<createDocumentResponse>(`/datasets/${datasetId}/documents`, { body })
  81. }
  82. export const fetchIndexingEstimate: Fetcher<IndexingEstimateResponse, CommonDocReq> = ({ datasetId, documentId }) => {
  83. return get<IndexingEstimateResponse>(`/datasets/${datasetId}/documents/${documentId}/indexing-estimate`, {})
  84. }
  85. export const fetchIndexingEstimateBatch: Fetcher<IndexingEstimateResponse, BatchReq> = ({ datasetId, batchId }) => {
  86. return get<IndexingEstimateResponse>(`/datasets/${datasetId}/batch/${batchId}/indexing-estimate`, {})
  87. }
  88. export const fetchIndexingStatus: Fetcher<IndexingStatusResponse, CommonDocReq> = ({ datasetId, documentId }) => {
  89. return get<IndexingStatusResponse>(`/datasets/${datasetId}/documents/${documentId}/indexing-status`, {})
  90. }
  91. export const fetchIndexingStatusBatch: Fetcher<IndexingStatusBatchResponse, BatchReq> = ({ datasetId, batchId }) => {
  92. return get<IndexingStatusBatchResponse>(`/datasets/${datasetId}/batch/${batchId}/indexing-status`, {})
  93. }
  94. export const fetchDocumentDetail: Fetcher<DocumentDetailResponse, CommonDocReq & { params: { metadata?: MetadataType } }> = ({ datasetId, documentId, params }) => {
  95. return get<DocumentDetailResponse>(`/datasets/${datasetId}/documents/${documentId}`, { params })
  96. }
  97. export const renameDocumentName: Fetcher<CommonResponse, CommonDocReq & { name: string }> = ({ datasetId, documentId, name }) => {
  98. return post<CommonResponse>(`/datasets/${datasetId}/documents/${documentId}/rename`, {
  99. body: { name },
  100. })
  101. }
  102. export const pauseDocIndexing: Fetcher<CommonResponse, CommonDocReq> = ({ datasetId, documentId }) => {
  103. return patch<CommonResponse>(`/datasets/${datasetId}/documents/${documentId}/processing/pause`)
  104. }
  105. export const resumeDocIndexing: Fetcher<CommonResponse, CommonDocReq> = ({ datasetId, documentId }) => {
  106. return patch<CommonResponse>(`/datasets/${datasetId}/documents/${documentId}/processing/resume`)
  107. }
  108. export const deleteDocument: Fetcher<CommonResponse, CommonDocReq> = ({ datasetId, documentId }) => {
  109. return del<CommonResponse>(`/datasets/${datasetId}/documents/${documentId}`)
  110. }
  111. export const archiveDocument: Fetcher<CommonResponse, CommonDocReq> = ({ datasetId, documentId }) => {
  112. return patch<CommonResponse>(`/datasets/${datasetId}/documents/${documentId}/status/archive`)
  113. }
  114. export const unArchiveDocument: Fetcher<CommonResponse, CommonDocReq> = ({ datasetId, documentId }) => {
  115. return patch<CommonResponse>(`/datasets/${datasetId}/documents/${documentId}/status/un_archive`)
  116. }
  117. export const enableDocument: Fetcher<CommonResponse, CommonDocReq> = ({ datasetId, documentId }) => {
  118. return patch<CommonResponse>(`/datasets/${datasetId}/documents/${documentId}/status/enable`)
  119. }
  120. export const disableDocument: Fetcher<CommonResponse, CommonDocReq> = ({ datasetId, documentId }) => {
  121. return patch<CommonResponse>(`/datasets/${datasetId}/documents/${documentId}/status/disable`)
  122. }
  123. export const syncDocument: Fetcher<CommonResponse, CommonDocReq> = ({ datasetId, documentId }) => {
  124. return get<CommonResponse>(`/datasets/${datasetId}/documents/${documentId}/notion/sync`)
  125. }
  126. export const syncWebsite: Fetcher<CommonResponse, CommonDocReq> = ({ datasetId, documentId }) => {
  127. return get<CommonResponse>(`/datasets/${datasetId}/documents/${documentId}/website-sync`)
  128. }
  129. export const preImportNotionPages: Fetcher<{ notion_info: DataSourceNotionWorkspace[] }, { url: string; datasetId?: string }> = ({ url, datasetId }) => {
  130. return get<{ notion_info: DataSourceNotionWorkspace[] }>(url, { params: { dataset_id: datasetId } })
  131. }
  132. export const modifyDocMetadata: Fetcher<CommonResponse, CommonDocReq & { body: { doc_type: string; doc_metadata: Record<string, any> } }> = ({ datasetId, documentId, body }) => {
  133. return put<CommonResponse>(`/datasets/${datasetId}/documents/${documentId}/metadata`, { body })
  134. }
  135. // apis for segments in a document
  136. export const fetchSegments: Fetcher<SegmentsResponse, CommonDocReq & { params: SegmentsQuery }> = ({ datasetId, documentId, params }) => {
  137. return get<SegmentsResponse>(`/datasets/${datasetId}/documents/${documentId}/segments`, { params })
  138. }
  139. export const enableSegment: Fetcher<CommonResponse, { datasetId: string; segmentId: string }> = ({ datasetId, segmentId }) => {
  140. return patch<CommonResponse>(`/datasets/${datasetId}/segments/${segmentId}/enable`)
  141. }
  142. export const disableSegment: Fetcher<CommonResponse, { datasetId: string; segmentId: string }> = ({ datasetId, segmentId }) => {
  143. return patch<CommonResponse>(`/datasets/${datasetId}/segments/${segmentId}/disable`)
  144. }
  145. export const updateSegment: Fetcher<{ data: SegmentDetailModel; doc_form: string }, { datasetId: string; documentId: string; segmentId: string; body: SegmentUpdator }> = ({ datasetId, documentId, segmentId, body }) => {
  146. return patch<{ data: SegmentDetailModel; doc_form: string }>(`/datasets/${datasetId}/documents/${documentId}/segments/${segmentId}`, { body })
  147. }
  148. export const addSegment: Fetcher<{ data: SegmentDetailModel; doc_form: string }, { datasetId: string; documentId: string; body: SegmentUpdator }> = ({ datasetId, documentId, body }) => {
  149. return post<{ data: SegmentDetailModel; doc_form: string }>(`/datasets/${datasetId}/documents/${documentId}/segment`, { body })
  150. }
  151. export const deleteSegment: Fetcher<CommonResponse, { datasetId: string; documentId: string; segmentId: string }> = ({ datasetId, documentId, segmentId }) => {
  152. return del<CommonResponse>(`/datasets/${datasetId}/documents/${documentId}/segments/${segmentId}`)
  153. }
  154. export const segmentBatchImport: Fetcher<{ job_id: string; job_status: string }, { url: string; body: FormData }> = ({ url, body }) => {
  155. return post<{ job_id: string; job_status: string }>(url, { body }, { bodyStringify: false, deleteContentType: true })
  156. }
  157. export const checkSegmentBatchImportProgress: Fetcher<{ job_id: string; job_status: string }, { jobID: string }> = ({ jobID }) => {
  158. return get<{ job_id: string; job_status: string }>(`/datasets/batch_import_status/${jobID}`)
  159. }
  160. // hit testing
  161. export const hitTesting: Fetcher<HitTestingResponse, { datasetId: string; queryText: string; retrieval_model: RetrievalConfig }> = ({ datasetId, queryText, retrieval_model }) => {
  162. return post<HitTestingResponse>(`/datasets/${datasetId}/hit-testing`, { body: { query: queryText, retrieval_model } })
  163. }
  164. export const fetchTestingRecords: Fetcher<HitTestingRecordsResponse, { datasetId: string; params: { page: number; limit: number } }> = ({ datasetId, params }) => {
  165. return get<HitTestingRecordsResponse>(`/datasets/${datasetId}/queries`, { params })
  166. }
  167. export const fetchFileIndexingEstimate: Fetcher<FileIndexingEstimateResponse, IndexingEstimateParams> = (body: IndexingEstimateParams) => {
  168. return post<FileIndexingEstimateResponse>('/datasets/indexing-estimate', { body })
  169. }
  170. export const fetchNotionPagePreview: Fetcher<{ content: string }, { workspaceID: string; pageID: string; pageType: string }> = ({ workspaceID, pageID, pageType }) => {
  171. return get<{ content: string }>(`notion/workspaces/${workspaceID}/pages/${pageID}/${pageType}/preview`)
  172. }
  173. export const fetchApiKeysList: Fetcher<ApikeysListResponse, { url: string; params: Record<string, any> }> = ({ url, params }) => {
  174. return get<ApikeysListResponse>(url, params)
  175. }
  176. export const delApikey: Fetcher<CommonResponse, { url: string; params: Record<string, any> }> = ({ url, params }) => {
  177. return del<CommonResponse>(url, params)
  178. }
  179. export const createApikey: Fetcher<CreateApiKeyResponse, { url: string; body: Record<string, any> }> = ({ url, body }) => {
  180. return post<CreateApiKeyResponse>(url, body)
  181. }
  182. export const fetchDatasetApiBaseUrl: Fetcher<{ api_base_url: string }, string> = (url) => {
  183. return get<{ api_base_url: string }>(url)
  184. }
  185. export const fetchDataSources = () => {
  186. return get<CommonResponse>('api-key-auth/data-source')
  187. }
  188. export const createDataSourceApiKeyBinding: Fetcher<CommonResponse, Record<string, any>> = (body) => {
  189. return post<CommonResponse>('api-key-auth/data-source/binding', { body })
  190. }
  191. export const removeDataSourceApiKeyBinding: Fetcher<CommonResponse, string> = (id: string) => {
  192. return del<CommonResponse>(`api-key-auth/data-source/${id}`)
  193. }
  194. export const createFirecrawlTask: Fetcher<CommonResponse, Record<string, any>> = (body) => {
  195. return post<CommonResponse>('website/crawl', {
  196. body: {
  197. ...body,
  198. provider: 'firecrawl',
  199. },
  200. })
  201. }
  202. export const checkFirecrawlTaskStatus: Fetcher<CommonResponse, string> = (jobId: string) => {
  203. return get<CommonResponse>(`website/crawl/status/${jobId}`, {
  204. params: {
  205. provider: 'firecrawl',
  206. },
  207. }, {
  208. silent: true,
  209. })
  210. }
  211. type FileTypesRes = {
  212. allowed_extensions: string[]
  213. }
  214. export const fetchSupportFileTypes: Fetcher<FileTypesRes, { url: string }> = ({ url }) => {
  215. return get<FileTypesRes>(url)
  216. }
  217. export const getErrorDocs: Fetcher<ErrorDocsResponse, { datasetId: string }> = ({ datasetId }) => {
  218. return get<ErrorDocsResponse>(`/datasets/${datasetId}/error-docs`)
  219. }
  220. export const retryErrorDocs: Fetcher<CommonResponse, { datasetId: string; document_ids: string[] }> = ({ datasetId, document_ids }) => {
  221. return post<CommonResponse>(`/datasets/${datasetId}/retry`, { body: { document_ids } })
  222. }