datasets.ts 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286
  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. SegmentUpdater,
  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' | 'partial_member_list' | '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 checkIsUsedInApp: Fetcher<{ is_using: boolean }, string> = (id) => {
  65. return get<{ is_using: boolean }>(`/datasets/${id}/use-check`, {}, {
  66. silent: true,
  67. })
  68. }
  69. export const deleteDataset: Fetcher<DataSet, string> = (datasetID) => {
  70. return del<DataSet>(`/datasets/${datasetID}`)
  71. }
  72. export const fetchDefaultProcessRule: Fetcher<ProcessRuleResponse, { url: string }> = ({ url }) => {
  73. return get<ProcessRuleResponse>(url)
  74. }
  75. export const fetchProcessRule: Fetcher<ProcessRuleResponse, { params: { documentId: string } }> = ({ params: { documentId } }) => {
  76. return get<ProcessRuleResponse>('/datasets/process-rule', { params: { document_id: documentId } })
  77. }
  78. export const fetchDocuments: Fetcher<DocumentListResponse, { datasetId: string; params: { keyword: string; page: number; limit: number; sort?: SortType } }> = ({ datasetId, params }) => {
  79. return get<DocumentListResponse>(`/datasets/${datasetId}/documents`, { params })
  80. }
  81. export const createFirstDocument: Fetcher<createDocumentResponse, { body: CreateDocumentReq }> = ({ body }) => {
  82. return post<createDocumentResponse>('/datasets/init', { body })
  83. }
  84. export const createDocument: Fetcher<createDocumentResponse, { datasetId: string; body: CreateDocumentReq }> = ({ datasetId, body }) => {
  85. return post<createDocumentResponse>(`/datasets/${datasetId}/documents`, { body })
  86. }
  87. export const fetchIndexingEstimate: Fetcher<IndexingEstimateResponse, CommonDocReq> = ({ datasetId, documentId }) => {
  88. return get<IndexingEstimateResponse>(`/datasets/${datasetId}/documents/${documentId}/indexing-estimate`, {})
  89. }
  90. export const fetchIndexingEstimateBatch: Fetcher<IndexingEstimateResponse, BatchReq> = ({ datasetId, batchId }) => {
  91. return get<IndexingEstimateResponse>(`/datasets/${datasetId}/batch/${batchId}/indexing-estimate`, {})
  92. }
  93. export const fetchIndexingStatus: Fetcher<IndexingStatusResponse, CommonDocReq> = ({ datasetId, documentId }) => {
  94. return get<IndexingStatusResponse>(`/datasets/${datasetId}/documents/${documentId}/indexing-status`, {})
  95. }
  96. export const fetchIndexingStatusBatch: Fetcher<IndexingStatusBatchResponse, BatchReq> = ({ datasetId, batchId }) => {
  97. return get<IndexingStatusBatchResponse>(`/datasets/${datasetId}/batch/${batchId}/indexing-status`, {})
  98. }
  99. export const fetchDocumentDetail: Fetcher<DocumentDetailResponse, CommonDocReq & { params: { metadata?: MetadataType } }> = ({ datasetId, documentId, params }) => {
  100. return get<DocumentDetailResponse>(`/datasets/${datasetId}/documents/${documentId}`, { params })
  101. }
  102. export const renameDocumentName: Fetcher<CommonResponse, CommonDocReq & { name: string }> = ({ datasetId, documentId, name }) => {
  103. return post<CommonResponse>(`/datasets/${datasetId}/documents/${documentId}/rename`, {
  104. body: { name },
  105. })
  106. }
  107. export const pauseDocIndexing: Fetcher<CommonResponse, CommonDocReq> = ({ datasetId, documentId }) => {
  108. return patch<CommonResponse>(`/datasets/${datasetId}/documents/${documentId}/processing/pause`)
  109. }
  110. export const resumeDocIndexing: Fetcher<CommonResponse, CommonDocReq> = ({ datasetId, documentId }) => {
  111. return patch<CommonResponse>(`/datasets/${datasetId}/documents/${documentId}/processing/resume`)
  112. }
  113. export const deleteDocument: Fetcher<CommonResponse, CommonDocReq> = ({ datasetId, documentId }) => {
  114. return del<CommonResponse>(`/datasets/${datasetId}/documents/${documentId}`)
  115. }
  116. export const archiveDocument: Fetcher<CommonResponse, CommonDocReq> = ({ datasetId, documentId }) => {
  117. return patch<CommonResponse>(`/datasets/${datasetId}/documents/${documentId}/status/archive`)
  118. }
  119. export const unArchiveDocument: Fetcher<CommonResponse, CommonDocReq> = ({ datasetId, documentId }) => {
  120. return patch<CommonResponse>(`/datasets/${datasetId}/documents/${documentId}/status/un_archive`)
  121. }
  122. export const enableDocument: Fetcher<CommonResponse, CommonDocReq> = ({ datasetId, documentId }) => {
  123. return patch<CommonResponse>(`/datasets/${datasetId}/documents/${documentId}/status/enable`)
  124. }
  125. export const disableDocument: Fetcher<CommonResponse, CommonDocReq> = ({ datasetId, documentId }) => {
  126. return patch<CommonResponse>(`/datasets/${datasetId}/documents/${documentId}/status/disable`)
  127. }
  128. export const syncDocument: Fetcher<CommonResponse, CommonDocReq> = ({ datasetId, documentId }) => {
  129. return get<CommonResponse>(`/datasets/${datasetId}/documents/${documentId}/notion/sync`)
  130. }
  131. export const syncWebsite: Fetcher<CommonResponse, CommonDocReq> = ({ datasetId, documentId }) => {
  132. return get<CommonResponse>(`/datasets/${datasetId}/documents/${documentId}/website-sync`)
  133. }
  134. export const preImportNotionPages: Fetcher<{ notion_info: DataSourceNotionWorkspace[] }, { url: string; datasetId?: string }> = ({ url, datasetId }) => {
  135. return get<{ notion_info: DataSourceNotionWorkspace[] }>(url, { params: { dataset_id: datasetId } })
  136. }
  137. export const modifyDocMetadata: Fetcher<CommonResponse, CommonDocReq & { body: { doc_type: string; doc_metadata: Record<string, any> } }> = ({ datasetId, documentId, body }) => {
  138. return put<CommonResponse>(`/datasets/${datasetId}/documents/${documentId}/metadata`, { body })
  139. }
  140. // apis for segments in a document
  141. export const fetchSegments: Fetcher<SegmentsResponse, CommonDocReq & { params: SegmentsQuery }> = ({ datasetId, documentId, params }) => {
  142. return get<SegmentsResponse>(`/datasets/${datasetId}/documents/${documentId}/segments`, { params })
  143. }
  144. export const enableSegment: Fetcher<CommonResponse, { datasetId: string; segmentId: string }> = ({ datasetId, segmentId }) => {
  145. return patch<CommonResponse>(`/datasets/${datasetId}/segments/${segmentId}/enable`)
  146. }
  147. export const disableSegment: Fetcher<CommonResponse, { datasetId: string; segmentId: string }> = ({ datasetId, segmentId }) => {
  148. return patch<CommonResponse>(`/datasets/${datasetId}/segments/${segmentId}/disable`)
  149. }
  150. export const updateSegment: Fetcher<{ data: SegmentDetailModel; doc_form: string }, { datasetId: string; documentId: string; segmentId: string; body: SegmentUpdater }> = ({ datasetId, documentId, segmentId, body }) => {
  151. return patch<{ data: SegmentDetailModel; doc_form: string }>(`/datasets/${datasetId}/documents/${documentId}/segments/${segmentId}`, { body })
  152. }
  153. export const addSegment: Fetcher<{ data: SegmentDetailModel; doc_form: string }, { datasetId: string; documentId: string; body: SegmentUpdater }> = ({ datasetId, documentId, body }) => {
  154. return post<{ data: SegmentDetailModel; doc_form: string }>(`/datasets/${datasetId}/documents/${documentId}/segment`, { body })
  155. }
  156. export const deleteSegment: Fetcher<CommonResponse, { datasetId: string; documentId: string; segmentId: string }> = ({ datasetId, documentId, segmentId }) => {
  157. return del<CommonResponse>(`/datasets/${datasetId}/documents/${documentId}/segments/${segmentId}`)
  158. }
  159. export const segmentBatchImport: Fetcher<{ job_id: string; job_status: string }, { url: string; body: FormData }> = ({ url, body }) => {
  160. return post<{ job_id: string; job_status: string }>(url, { body }, { bodyStringify: false, deleteContentType: true })
  161. }
  162. export const checkSegmentBatchImportProgress: Fetcher<{ job_id: string; job_status: string }, { jobID: string }> = ({ jobID }) => {
  163. return get<{ job_id: string; job_status: string }>(`/datasets/batch_import_status/${jobID}`)
  164. }
  165. // hit testing
  166. export const hitTesting: Fetcher<HitTestingResponse, { datasetId: string; queryText: string; retrieval_model: RetrievalConfig }> = ({ datasetId, queryText, retrieval_model }) => {
  167. return post<HitTestingResponse>(`/datasets/${datasetId}/hit-testing`, { body: { query: queryText, retrieval_model } })
  168. }
  169. export const fetchTestingRecords: Fetcher<HitTestingRecordsResponse, { datasetId: string; params: { page: number; limit: number } }> = ({ datasetId, params }) => {
  170. return get<HitTestingRecordsResponse>(`/datasets/${datasetId}/queries`, { params })
  171. }
  172. export const fetchFileIndexingEstimate: Fetcher<FileIndexingEstimateResponse, IndexingEstimateParams> = (body: IndexingEstimateParams) => {
  173. return post<FileIndexingEstimateResponse>('/datasets/indexing-estimate', { body })
  174. }
  175. export const fetchNotionPagePreview: Fetcher<{ content: string }, { workspaceID: string; pageID: string; pageType: string }> = ({ workspaceID, pageID, pageType }) => {
  176. return get<{ content: string }>(`notion/workspaces/${workspaceID}/pages/${pageID}/${pageType}/preview`)
  177. }
  178. export const fetchApiKeysList: Fetcher<ApiKeysListResponse, { url: string; params: Record<string, any> }> = ({ url, params }) => {
  179. return get<ApiKeysListResponse>(url, params)
  180. }
  181. export const delApikey: Fetcher<CommonResponse, { url: string; params: Record<string, any> }> = ({ url, params }) => {
  182. return del<CommonResponse>(url, params)
  183. }
  184. export const createApikey: Fetcher<CreateApiKeyResponse, { url: string; body: Record<string, any> }> = ({ url, body }) => {
  185. return post<CreateApiKeyResponse>(url, body)
  186. }
  187. export const fetchDatasetApiBaseUrl: Fetcher<{ api_base_url: string }, string> = (url) => {
  188. return get<{ api_base_url: string }>(url)
  189. }
  190. export const fetchDataSources = () => {
  191. return get<CommonResponse>('api-key-auth/data-source')
  192. }
  193. export const createDataSourceApiKeyBinding: Fetcher<CommonResponse, Record<string, any>> = (body) => {
  194. return post<CommonResponse>('api-key-auth/data-source/binding', { body })
  195. }
  196. export const removeDataSourceApiKeyBinding: Fetcher<CommonResponse, string> = (id: string) => {
  197. return del<CommonResponse>(`api-key-auth/data-source/${id}`)
  198. }
  199. export const createFirecrawlTask: Fetcher<CommonResponse, Record<string, any>> = (body) => {
  200. return post<CommonResponse>('website/crawl', {
  201. body: {
  202. ...body,
  203. provider: 'firecrawl',
  204. },
  205. })
  206. }
  207. export const checkFirecrawlTaskStatus: Fetcher<CommonResponse, string> = (jobId: string) => {
  208. return get<CommonResponse>(`website/crawl/status/${jobId}`, {
  209. params: {
  210. provider: 'firecrawl',
  211. },
  212. }, {
  213. silent: true,
  214. })
  215. }
  216. type FileTypesRes = {
  217. allowed_extensions: string[]
  218. }
  219. export const fetchSupportFileTypes: Fetcher<FileTypesRes, { url: string }> = ({ url }) => {
  220. return get<FileTypesRes>(url)
  221. }
  222. export const getErrorDocs: Fetcher<ErrorDocsResponse, { datasetId: string }> = ({ datasetId }) => {
  223. return get<ErrorDocsResponse>(`/datasets/${datasetId}/error-docs`)
  224. }
  225. export const retryErrorDocs: Fetcher<CommonResponse, { datasetId: string; document_ids: string[] }> = ({ datasetId, document_ids }) => {
  226. return post<CommonResponse>(`/datasets/${datasetId}/retry`, { body: { document_ids } })
  227. }