SunnyQjm/dify
1
0 Fork 0
mirror of https://github.com/langgenius/dify.git synced 2026-10-04 13:47:55 +08:00
Code Issues Projects Releases Wiki Activity

refactor(api): establish dataset application boundaries (#41729)

Browse Source 
Co-authored-by: Jyong <jyong@dify.ai>
This commit is contained in:
Byron.wangandJyong authored and GitHub committed 2026-09-29 08:42:31 +00:00
1 parent c005932db9
commit a67cd87eb0
417 files changed
+30522 -23751
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

packages/contracts/generated/api/console/data-source/orpc.gen.ts
+2 -28
View File
@@ -3,25 +3,11 @@
import { oc } from '@orpc/contract'
import * as z from 'zod'
import {
zGetDataSourceIntegratesByBindingIdByActionPath,
zGetDataSourceIntegratesByBindingIdByActionResponse,
zGetDataSourceIntegratesResponse,
zPatchDataSourceIntegratesByBindingIdByActionPath,
zPatchDataSourceIntegratesByBindingIdByActionResponse,
zPatchDataSourceIntegratesResponse,
} from './zod.gen.ts'
export const get = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDataSourceIntegratesByBindingIdByAction',
path: '/data-source/integrates/{binding_id}/{action}',
tags: ['console'],
})
.input(z.object({ params: zGetDataSourceIntegratesByBindingIdByActionPath }))
.output(zGetDataSourceIntegratesByBindingIdByActionResponse)
export const patch = oc
.route({
inputStructure: 'detailed',
@@ -34,7 +20,6 @@ export const patch = oc
.output(zPatchDataSourceIntegratesByBindingIdByActionResponse)
export const byAction = {
get,
patch,
}
@@ -42,7 +27,7 @@ export const byBindingId = {
byAction,
}
export const get2 = oc
export const get = oc
.route({
inputStructure: 'detailed',
method: 'GET',
@@ -52,19 +37,8 @@ export const get2 = oc
})
.output(zGetDataSourceIntegratesResponse)
export const patch2 = oc
.route({
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchDataSourceIntegrates',
path: '/data-source/integrates',
tags: ['console'],
})
.output(zPatchDataSourceIntegratesResponse)
export const integrates = {
get: get2,
patch: patch2,
get,
byBindingId,
}
packages/contracts/generated/api/console/data-source/types.gen.ts
+44 -41
View File
@@ -4,6 +4,48 @@ export type ClientOptions = {
baseUrl: `${string}://${string}/console/api` | (string & {})
}
export type DataSourceIntegrateListResponse = {
data: Array<DataSourceIntegrateResponse>
}
export type SimpleResultResponse = {
result: string
}
export type DataSourceIntegrateResponse = {
created_at: number | null
disabled: boolean | null
id: string | null
is_bound: boolean
link: string
provider: string
source_info: DataSourceIntegrateWorkspaceResponse | null
}
export type DataSourceIntegrateWorkspaceResponse = {
pages: Array<DataSourceIntegratePageResponse>
total: number
workspace_icon: string | null
workspace_id: string | null
workspace_name: string | null
}
export type DataSourceIntegratePageResponse = {
page_icon: DataSourceIntegrateIconResponse | null
page_id: string
page_name: string
parent_id: string
type: NotionPageType
}
export type DataSourceIntegrateIconResponse = {
emoji?: string | null
type?: string | null
url?: string | null
}
export type NotionPageType = 'database' | 'page'
export type GetDataSourceIntegratesData = {
body?: never
path?: never
@@ -12,49 +54,12 @@ export type GetDataSourceIntegratesData = {
}
export type GetDataSourceIntegratesResponses = {
200: {
[key: string]: unknown
}
200: DataSourceIntegrateListResponse
}
export type GetDataSourceIntegratesResponse =
GetDataSourceIntegratesResponses[keyof GetDataSourceIntegratesResponses]
export type PatchDataSourceIntegratesData = {
body?: never
path?: never
query?: never
url: '/data-source/integrates'
}
export type PatchDataSourceIntegratesResponses = {
200: {
[key: string]: unknown
}
}
export type PatchDataSourceIntegratesResponse =
PatchDataSourceIntegratesResponses[keyof PatchDataSourceIntegratesResponses]
export type GetDataSourceIntegratesByBindingIdByActionData = {
body?: never
path: {
action: string
binding_id: string
}
query?: never
url: '/data-source/integrates/{binding_id}/{action}'
}
export type GetDataSourceIntegratesByBindingIdByActionResponses = {
200: {
[key: string]: unknown
}
}
export type GetDataSourceIntegratesByBindingIdByActionResponse =
GetDataSourceIntegratesByBindingIdByActionResponses[keyof GetDataSourceIntegratesByBindingIdByActionResponses]
export type PatchDataSourceIntegratesByBindingIdByActionData = {
body?: never
path: {
@@ -66,9 +71,7 @@ export type PatchDataSourceIntegratesByBindingIdByActionData = {
}
export type PatchDataSourceIntegratesByBindingIdByActionResponses = {
200: {
[key: string]: unknown
}
200: SimpleResultResponse
}
export type PatchDataSourceIntegratesByBindingIdByActionResponse =
packages/contracts/generated/api/console/data-source/zod.gen.ts
+57 -12
View File
@@ -3,24 +3,72 @@
import * as z from 'zod'
/**
* Success
* SimpleResultResponse
*/
export const zGetDataSourceIntegratesResponse = z.record(z.string(), z.unknown())
export const zSimpleResultResponse = z.object({
result: z.string(),
})
/**
* Success
* DataSourceIntegrateIconResponse
*/
export const zPatchDataSourceIntegratesResponse = z.record(z.string(), z.unknown())
export const zDataSourceIntegrateIconResponse = z.object({
emoji: z.string().nullish(),
type: z.string().nullish(),
url: z.string().nullish(),
})
export const zGetDataSourceIntegratesByBindingIdByActionPath = z.object({
action: z.string(),
binding_id: z.uuid(),
/**
* NotionPageType
*/
export const zNotionPageType = z.enum(['database', 'page'])
/**
* DataSourceIntegratePageResponse
*/
export const zDataSourceIntegratePageResponse = z.object({
page_icon: zDataSourceIntegrateIconResponse.nullable(),
page_id: z.string(),
page_name: z.string(),
parent_id: z.string(),
type: zNotionPageType,
})
/**
* DataSourceIntegrateWorkspaceResponse
*/
export const zDataSourceIntegrateWorkspaceResponse = z.object({
pages: z.array(zDataSourceIntegratePageResponse),
total: z.int(),
workspace_icon: z.string().nullable(),
workspace_id: z.string().nullable(),
workspace_name: z.string().nullable(),
})
/**
* DataSourceIntegrateResponse
*/
export const zDataSourceIntegrateResponse = z.object({
created_at: z.int().nullable(),
disabled: z.boolean().nullable(),
id: z.string().nullable(),
is_bound: z.boolean(),
link: z.string(),
provider: z.string(),
source_info: zDataSourceIntegrateWorkspaceResponse.nullable(),
})
/**
* DataSourceIntegrateListResponse
*/
export const zDataSourceIntegrateListResponse = z.object({
data: z.array(zDataSourceIntegrateResponse),
})
/**
* Success
*/
export const zGetDataSourceIntegratesByBindingIdByActionResponse = z.record(z.string(), z.unknown())
export const zGetDataSourceIntegratesResponse = zDataSourceIntegrateListResponse
export const zPatchDataSourceIntegratesByBindingIdByActionPath = z.object({
action: z.string(),
@@ -30,7 +78,4 @@ export const zPatchDataSourceIntegratesByBindingIdByActionPath = z.object({
/**
* Success
*/
export const zPatchDataSourceIntegratesByBindingIdByActionResponse = z.record(
z.string(),
z.unknown(),
)
export const zPatchDataSourceIntegratesByBindingIdByActionResponse = zSimpleResultResponse
packages/contracts/generated/api/console/datasets/orpc.gen.ts
+76 -110
View File
@@ -47,8 +47,6 @@ import {
zGetDatasetsByDatasetIdDocumentsByDocumentIdPipelineExecutionLogResponse,
zGetDatasetsByDatasetIdDocumentsByDocumentIdQuery,
zGetDatasetsByDatasetIdDocumentsByDocumentIdResponse,
zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportPath,
zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportResponse,
zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksPath,
zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksQuery,
zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksResponse,
@@ -127,9 +125,6 @@ import {
zPatchDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdResponse,
zPostDatasetsApiKeysBody,
zPostDatasetsApiKeysResponse,
zPostDatasetsBatchImportStatusByJobIdBody,
zPostDatasetsBatchImportStatusByJobIdPath,
zPostDatasetsBatchImportStatusByJobIdResponse,
zPostDatasetsBody,
zPostDatasetsByDatasetIdApiKeysByStatusPath,
zPostDatasetsByDatasetIdApiKeysByStatusResponse,
@@ -269,25 +264,8 @@ export const get3 = oc
.input(z.object({ params: zGetDatasetsBatchImportStatusByJobIdPath }))
.output(zGetDatasetsBatchImportStatusByJobIdResponse)
export const post2 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsBatchImportStatusByJobId',
path: '/datasets/batch_import_status/{job_id}',
tags: ['console'],
})
.input(
z.object({
body: zPostDatasetsBatchImportStatusByJobIdBody,
params: zPostDatasetsBatchImportStatusByJobIdPath,
}),
)
.output(zPostDatasetsBatchImportStatusByJobIdResponse)
export const byJobId = {
get: get3,
post: post2,
}
export const batchImportStatus = {
@@ -297,7 +275,7 @@ export const batchImportStatus = {
/**
* Create external knowledge dataset
*/
export const post3 = oc
export const post2 = oc
.route({
description: 'Create external knowledge dataset',
inputStructure: 'detailed',
@@ -311,7 +289,7 @@ export const post3 = oc
.output(zPostDatasetsExternalResponse)
export const external = {
post: post3,
post: post2,
}
/**
@@ -405,7 +383,7 @@ export const get6 = oc
/**
* Create external knowledge API template
*/
export const post4 = oc
export const post3 = oc
.route({
description: 'Create external knowledge API template',
inputStructure: 'detailed',
@@ -420,14 +398,14 @@ export const post4 = oc
export const externalKnowledgeApi = {
get: get6,
post: post4,
post: post3,
byExternalKnowledgeApiId,
}
/**
* Estimate dataset indexing cost
*/
export const post5 = oc
export const post4 = oc
.route({
description: 'Estimate dataset indexing cost',
inputStructure: 'detailed',
@@ -440,13 +418,13 @@ export const post5 = oc
.output(zPostDatasetsIndexingEstimateResponse)
export const indexingEstimate = {
post: post5,
post: post4,
}
/**
* Initialize dataset with documents
*/
export const post6 = oc
export const post5 = oc
.route({
description: 'Initialize dataset with documents',
inputStructure: 'detailed',
@@ -459,7 +437,7 @@ export const post6 = oc
.output(zPostDatasetsInitResponse)
export const init = {
post: post6,
post: post5,
}
export const get7 = oc
@@ -480,7 +458,7 @@ export const metadata = {
builtIn,
}
export const post7 = oc
export const post6 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
@@ -492,7 +470,7 @@ export const post7 = oc
.output(zPostDatasetsNotionIndexingEstimateResponse)
export const notionIndexingEstimate = {
post: post7,
post: post6,
}
/**
@@ -552,7 +530,7 @@ export const retrievalSetting = {
byVectorType,
}
export const post8 = oc
export const post7 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
@@ -564,7 +542,7 @@ export const post8 = oc
.output(zPostDatasetsByDatasetIdApiKeysByStatusResponse)
export const byStatus = {
post: post8,
post: post7,
}
export const apiKeys2 = {
@@ -634,7 +612,7 @@ export const batch = {
*
* Download selected dataset documents as a single ZIP archive (upload-file only)
*/
export const post9 = oc
export const post8 = oc
.route({
description: 'Download selected dataset documents as a single ZIP archive (upload-file only)',
inputStructure: 'detailed',
@@ -653,7 +631,7 @@ export const post9 = oc
.output(zPostDatasetsByDatasetIdDocumentsDownloadZipResponse)
export const downloadZip = {
post: post9,
post: post8,
}
/**
@@ -664,7 +642,7 @@ export const downloadZip = {
* (indexing_technique must be 'high_quality' and summary_index_setting.enable must be true),
* then asynchronously generates summary indexes for the provided documents.
*/
export const post10 = oc
export const post9 = oc
.route({
description:
"Generate summary index for documents\nThis endpoint checks if the dataset configuration supports summary generation\n(indexing_technique must be 'high_quality' and summary_index_setting.enable must be true),\nthen asynchronously generates summary indexes for the provided documents.",
@@ -684,10 +662,10 @@ export const post10 = oc
.output(zPostDatasetsByDatasetIdDocumentsGenerateSummaryResponse)
export const generateSummary = {
post: post10,
post: post9,
}
export const post11 = oc
export const post10 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
@@ -705,7 +683,7 @@ export const post11 = oc
.output(zPostDatasetsByDatasetIdDocumentsMetadataResponse)
export const metadata2 = {
post: post11,
post: post10,
}
export const patch2 = oc
@@ -911,7 +889,7 @@ export const processing = {
byAction: byAction2,
}
export const post12 = oc
export const post11 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
@@ -928,7 +906,7 @@ export const post12 = oc
.output(zPostDatasetsByDatasetIdDocumentsByDocumentIdRenameResponse)
export const rename = {
post: post12,
post: post11,
}
export const patch6 = oc
@@ -951,7 +929,7 @@ export const byAction3 = {
patch: patch6,
}
export const post13 = oc
export const post12 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
@@ -968,22 +946,11 @@ export const post13 = oc
.output(zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentResponse)
export const segment = {
post: post13,
post: post12,
byAction: byAction3,
}
export const get19 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImport',
path: '/datasets/{dataset_id}/documents/{document_id}/segments/batch_import',
tags: ['console'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportPath }))
.output(zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportResponse)
export const post14 = oc
export const post13 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
@@ -1000,8 +967,7 @@ export const post14 = oc
.output(zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportResponse)
export const batchImport = {
get: get19,
post: post14,
post: post13,
}
export const delete3 = oc
@@ -1049,7 +1015,7 @@ export const byChildChunkId = {
patch: patch7,
}
export const get20 = oc
export const get19 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
@@ -1082,7 +1048,7 @@ export const patch8 = oc
)
.output(zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksResponse)
export const post15 = oc
export const post14 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
@@ -1099,9 +1065,9 @@ export const post15 = oc
.output(zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksResponse)
export const childChunks = {
get: get20,
get: get19,
patch: patch8,
post: post15,
post: post14,
byChildChunkId,
}
@@ -1158,7 +1124,7 @@ export const delete5 = oc
)
.output(zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsResponse)
export const get21 = oc
export const get20 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
@@ -1176,7 +1142,7 @@ export const get21 = oc
export const segments = {
delete: delete5,
get: get21,
get: get20,
batchImport,
bySegmentId,
}
@@ -1195,7 +1161,7 @@ export const segments = {
* - timeout: Number of summaries that timed out
* - summaries: List of summary records with status and content preview
*/
export const get22 = oc
export const get21 = oc
.route({
description:
'Get summary index generation status for a document\nReturns:\n- total_segments: Total number of segments in the document\n- summary_status: Dictionary with status counts\n - completed: Number of summaries completed\n - generating: Number of summaries being generated\n - error: Number of summaries with errors\n - not_started: Number of segments without summary records\n - timeout: Number of summaries that timed out\n- summaries: List of summary records with status and content preview',
@@ -1210,13 +1176,13 @@ export const get22 = oc
.output(zGetDatasetsByDatasetIdDocumentsByDocumentIdSummaryStatusResponse)
export const summaryStatus = {
get: get22,
get: get21,
}
/**
* sync website document
*/
export const get23 = oc
export const get22 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
@@ -1229,7 +1195,7 @@ export const get23 = oc
.output(zGetDatasetsByDatasetIdDocumentsByDocumentIdWebsiteSyncResponse)
export const websiteSync = {
get: get23,
get: get22,
}
export const delete6 = oc
@@ -1247,7 +1213,7 @@ export const delete6 = oc
/**
* Get document details
*/
export const get24 = oc
export const get23 = oc
.route({
description: 'Get document details',
inputStructure: 'detailed',
@@ -1266,7 +1232,7 @@ export const get24 = oc
export const byDocumentId = {
delete: delete6,
get: get24,
get: get23,
download,
indexingEstimate: indexingEstimate3,
indexingStatus: indexingStatus2,
@@ -1296,7 +1262,7 @@ export const delete7 = oc
/**
* Get documents in a dataset
*/
export const get25 = oc
export const get24 = oc
.route({
description: 'Get documents in a dataset',
inputStructure: 'detailed',
@@ -1313,7 +1279,7 @@ export const get25 = oc
)
.output(zGetDatasetsByDatasetIdDocumentsResponse)
export const post16 = oc
export const post15 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
@@ -1331,8 +1297,8 @@ export const post16 = oc
export const documents = {
delete: delete7,
get: get25,
post: post16,
get: get24,
post: post15,
downloadZip,
generateSummary,
metadata: metadata2,
@@ -1343,7 +1309,7 @@ export const documents = {
/**
* Get dataset error documents
*/
export const get26 = oc
export const get25 = oc
.route({
description: 'Get dataset error documents',
inputStructure: 'detailed',
@@ -1356,13 +1322,13 @@ export const get26 = oc
.output(zGetDatasetsByDatasetIdErrorDocsResponse)
export const errorDocs = {
get: get26,
get: get25,
}
/**
* Test external knowledge retrieval for dataset
*/
export const post17 = oc
export const post16 = oc
.route({
description: 'Test external knowledge retrieval for dataset',
inputStructure: 'detailed',
@@ -1380,13 +1346,13 @@ export const post17 = oc
.output(zPostDatasetsByDatasetIdExternalHitTestingResponse)
export const externalHitTesting = {
post: post17,
post: post16,
}
/**
* Test dataset knowledge retrieval
*/
export const post18 = oc
export const post17 = oc
.route({
description: 'Test dataset knowledge retrieval',
inputStructure: 'detailed',
@@ -1404,13 +1370,13 @@ export const post18 = oc
.output(zPostDatasetsByDatasetIdHitTestingResponse)
export const hitTesting = {
post: post18,
post: post17,
}
/**
* Get dataset indexing status
*/
export const get27 = oc
export const get26 = oc
.route({
description: 'Get dataset indexing status',
inputStructure: 'detailed',
@@ -1423,10 +1389,10 @@ export const get27 = oc
.output(zGetDatasetsByDatasetIdIndexingStatusResponse)
export const indexingStatus3 = {
get: get27,
get: get26,
}
export const post19 = oc
export const post18 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
@@ -1439,7 +1405,7 @@ export const post19 = oc
.output(zPostDatasetsByDatasetIdMetadataBuiltInByActionResponse)
export const byAction4 = {
post: post19,
post: post18,
}
export const builtIn2 = {
@@ -1479,7 +1445,7 @@ export const byMetadataId = {
patch: patch10,
}
export const get28 = oc
export const get27 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
@@ -1490,7 +1456,7 @@ export const get28 = oc
.input(z.object({ params: zGetDatasetsByDatasetIdMetadataPath }))
.output(zGetDatasetsByDatasetIdMetadataResponse)
export const post20 = oc
export const post19 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
@@ -1508,13 +1474,13 @@ export const post20 = oc
.output(zPostDatasetsByDatasetIdMetadataResponse)
export const metadata4 = {
get: get28,
post: post20,
get: get27,
post: post19,
builtIn: builtIn2,
byMetadataId,
}
export const get29 = oc
export const get28 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
@@ -1526,7 +1492,7 @@ export const get29 = oc
.output(zGetDatasetsByDatasetIdNotionSyncResponse)
export const sync2 = {
get: get29,
get: get28,
}
export const notion2 = {
@@ -1536,7 +1502,7 @@ export const notion2 = {
/**
* Get dataset permission user list
*/
export const get30 = oc
export const get29 = oc
.route({
description: 'Get dataset permission user list',
inputStructure: 'detailed',
@@ -1549,13 +1515,13 @@ export const get30 = oc
.output(zGetDatasetsByDatasetIdPermissionPartUsersResponse)
export const permissionPartUsers = {
get: get30,
get: get29,
}
/**
* Get dataset query history
*/
export const get31 = oc
export const get30 = oc
.route({
description: 'Get dataset query history',
inputStructure: 'detailed',
@@ -1568,13 +1534,13 @@ export const get31 = oc
.output(zGetDatasetsByDatasetIdQueriesResponse)
export const queries = {
get: get31,
get: get30,
}
/**
* Get applications related to dataset
*/
export const get32 = oc
export const get31 = oc
.route({
description: 'Get applications related to dataset',
inputStructure: 'detailed',
@@ -1587,13 +1553,13 @@ export const get32 = oc
.output(zGetDatasetsByDatasetIdRelatedAppsResponse)
export const relatedApps = {
get: get32,
get: get31,
}
/**
* retry document
*/
export const post21 = oc
export const post20 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
@@ -1612,13 +1578,13 @@ export const post21 = oc
.output(zPostDatasetsByDatasetIdRetryResponse)
export const retry = {
post: post21,
post: post20,
}
/**
* Check if dataset is in use
*/
export const get33 = oc
export const get32 = oc
.route({
description: 'Check if dataset is in use',
inputStructure: 'detailed',
@@ -1631,7 +1597,7 @@ export const get33 = oc
.output(zGetDatasetsByDatasetIdUseCheckResponse)
export const useCheck2 = {
get: get33,
get: get32,
}
export const delete9 = oc
@@ -1649,7 +1615,7 @@ export const delete9 = oc
/**
* Get dataset details
*/
export const get34 = oc
export const get33 = oc
.route({
description: 'Get dataset details',
inputStructure: 'detailed',
@@ -1678,7 +1644,7 @@ export const patch11 = oc
export const byDatasetId = {
delete: delete9,
get: get34,
get: get33,
patch: patch11,
apiKeys: apiKeys2,
autoDisableLogs,
@@ -1720,7 +1686,7 @@ export const byApiKeyId2 = {
/**
* Get all API keys for a dataset
*/
export const get35 = oc
export const get34 = oc
.route({
description: 'Get all API keys for a dataset',
inputStructure: 'detailed',
@@ -1735,7 +1701,7 @@ export const get35 = oc
/**
* Create a new API key for a dataset
*/
export const post22 = oc
export const post21 = oc
.route({
description: 'Create a new API key for a dataset',
inputStructure: 'detailed',
@@ -1749,8 +1715,8 @@ export const post22 = oc
.output(zPostDatasetsByResourceIdApiKeysResponse)
export const apiKeys3 = {
get: get35,
post: post22,
get: get34,
post: post21,
byApiKeyId: byApiKeyId2,
}
@@ -1761,7 +1727,7 @@ export const byResourceId = {
/**
* Get list of datasets
*/
export const get36 = oc
export const get35 = oc
.route({
description: 'Get list of datasets',
inputStructure: 'detailed',
@@ -1776,7 +1742,7 @@ export const get36 = oc
/**
* Create a new dataset
*/
export const post23 = oc
export const post22 = oc
.route({
description: 'Create a new dataset',
inputStructure: 'detailed',
@@ -1790,8 +1756,8 @@ export const post23 = oc
.output(zPostDatasetsResponse)
export const datasets = {
get: get36,
post: post23,
get: get35,
post: post22,
apiBaseInfo,
apiKeys,
batchImportStatus,
packages/contracts/generated/api/console/datasets/types.gen.ts
+64 -84
View File
@@ -22,7 +22,7 @@ export type DatasetCreatePayload = {
provider?: string
}
export type DatasetDetailResponse = {
export type DatasetDetailWithPartialMembersResponse = {
app_count: number
author_name: string | null
built_in_field_enabled: boolean
@@ -47,6 +47,7 @@ export type DatasetDetailResponse = {
is_published: boolean
maintainer?: string | null
name: string
partial_member_list?: Array<string> | null
permission: string
permission_keys?: Array<string>
pipeline_id: string | null
@@ -88,10 +89,6 @@ export type SegmentBatchImportStatusResponse = {
job_status: string
}
export type BatchImportPayload = {
upload_file_id: string
}
export type ExternalDatasetCreatePayload = {
description?: string | null
external_knowledge_api_id: string
@@ -102,6 +99,46 @@ export type ExternalDatasetCreatePayload = {
name: string
}
export type DatasetDetailResponse = {
app_count: number
author_name: string | null
built_in_field_enabled: boolean
chunk_structure: string | null
created_at: number
created_by: string
data_source_type: string | null
description: string | null
doc_form: string | null
doc_metadata: Array<DatasetDocMetadataResponse>
document_count: number
embedding_available?: boolean | null
embedding_model: string | null
embedding_model_provider: string | null
enable_api: boolean
external_knowledge_info?: DatasetExternalKnowledgeInfoResponse
external_retrieval_model: DatasetExternalRetrievalModelResponse | null
icon_info?: DatasetIconInfoResponse
id: string
indexing_technique: string | null
is_multimodal: boolean
is_published: boolean
maintainer?: string | null
name: string
permission: string
permission_keys?: Array<string>
pipeline_id: string | null
provider: string
retrieval_model_dict: DatasetRetrievalModelResponse
runtime_mode: string | null
summary_index_setting?: DatasetSummaryIndexSettingResponse
tags: Array<DatasetTagResponse>
total_available_documents: number
total_documents: number
updated_at: number
updated_by: string | null
word_count: number
}
export type ExternalKnowledgeApiListResponse = {
data: Array<ExternalKnowledgeApiResponse>
has_more: boolean
@@ -191,9 +228,7 @@ export type DatasetMetadataBuiltInFieldsResponse = {
export type NotionEstimatePayload = {
doc_form?: string
doc_language?: string
notion_info_list: Array<{
[key: string]: unknown
}>
notion_info_list: Array<NotionEstimateWorkspacePayload>
process_rule: {
[key: string]: unknown
}
@@ -217,47 +252,6 @@ export type RetrievalSettingResponse = {
retrieval_method: Array<string>
}
export type DatasetDetailWithPartialMembersResponse = {
app_count: number
author_name: string | null
built_in_field_enabled: boolean
chunk_structure: string | null
created_at: number
created_by: string
data_source_type: string | null
description: string | null
doc_form: string | null
doc_metadata: Array<DatasetDocMetadataResponse>
document_count: number
embedding_available?: boolean | null
embedding_model: string | null
embedding_model_provider: string | null
enable_api: boolean
external_knowledge_info?: DatasetExternalKnowledgeInfoResponse
external_retrieval_model: DatasetExternalRetrievalModelResponse | null
icon_info?: DatasetIconInfoResponse
id: string
indexing_technique: string | null
is_multimodal: boolean
is_published: boolean
maintainer?: string | null
name: string
partial_member_list?: Array<string> | null
permission: string
permission_keys?: Array<string>
pipeline_id: string | null
provider: string
retrieval_model_dict: DatasetRetrievalModelResponse
runtime_mode: string | null
summary_index_setting?: DatasetSummaryIndexSettingResponse
tags: Array<DatasetTagResponse>
total_available_documents: number
total_documents: number
updated_at: number
updated_by: string | null
word_count: number
}
export type DatasetUpdatePayload = {
description?: string | null
embedding_model?: string | null
@@ -443,6 +437,10 @@ export type ConsoleSegmentListResponse = {
total_pages: number
}
export type BatchImportPayload = {
upload_file_id: string
}
export type SegmentUpdatePayload = {
answer?: string | null
attachment_ids?: Array<string> | null
@@ -713,6 +711,12 @@ export type DatasetMetadataBuiltInFieldResponse = {
type: string
}
export type NotionEstimateWorkspacePayload = {
credential_id: string
pages: Array<NotionEstimatePagePayload>
workspace_id: string
}
export type ProcessRuleMode = 'automatic' | 'custom' | 'hierarchical'
export type Rule = {
@@ -929,9 +933,14 @@ export type WeightModel = {
weight_type?: 'customized' | 'keyword_first' | 'semantic_first' | null
}
export type NotionEstimatePagePayload = {
page_id: string
type: NotionPageType
}
export type PreProcessingRule = {
enabled: boolean
id: 'remove_extra_spaces' | 'remove_stopwords' | 'remove_urls_emails'
id: PreProcessingRuleKey
}
export type Segmentation = {
@@ -1064,6 +1073,10 @@ export type WeightVectorSetting = {
vector_weight: number
}
export type NotionPageType = 'database' | 'page'
export type PreProcessingRuleKey = 'remove_extra_spaces' | 'remove_stopwords' | 'remove_urls_emails'
export type HitTestingDocument = {
data_source_type: string
doc_metadata: unknown | null
@@ -1126,7 +1139,7 @@ export type PostDatasetsErrors = {
}
export type PostDatasetsResponses = {
201: DatasetDetailResponse
201: DatasetDetailWithPartialMembersResponse
}
export type PostDatasetsResponse = PostDatasetsResponses[keyof PostDatasetsResponses]
@@ -1209,22 +1222,6 @@ export type GetDatasetsBatchImportStatusByJobIdResponses = {
export type GetDatasetsBatchImportStatusByJobIdResponse =
GetDatasetsBatchImportStatusByJobIdResponses[keyof GetDatasetsBatchImportStatusByJobIdResponses]
export type PostDatasetsBatchImportStatusByJobIdData = {
body: BatchImportPayload
path: {
job_id: string
}
query?: never
url: '/datasets/batch_import_status/{job_id}'
}
export type PostDatasetsBatchImportStatusByJobIdResponses = {
200: SegmentBatchImportStatusResponse
}
export type PostDatasetsBatchImportStatusByJobIdResponse =
PostDatasetsBatchImportStatusByJobIdResponses[keyof PostDatasetsBatchImportStatusByJobIdResponses]
export type PostDatasetsExternalData = {
body: ExternalDatasetCreatePayload
path?: never
@@ -2028,23 +2025,6 @@ export type GetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsResponses = {
export type GetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsResponse =
GetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsResponses[keyof GetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsResponses]
export type GetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportData = {
body?: never
path: {
dataset_id: string
document_id: string
}
query?: never
url: '/datasets/{dataset_id}/documents/{document_id}/segments/batch_import'
}
export type GetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportResponses = {
200: SegmentBatchImportStatusResponse
}
export type GetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportResponse =
GetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportResponses[keyof GetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportResponses]
export type PostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportData = {
body: BatchImportPayload
path: {
packages/contracts/generated/api/console/datasets/zod.gen.ts
+124 -118
View File
@@ -43,13 +43,6 @@ export const zSegmentBatchImportStatusResponse = z.object({
job_status: z.string(),
})
/**
* BatchImportPayload
*/
export const zBatchImportPayload = z.object({
upload_file_id: z.string(),
})
/**
* ExternalDatasetCreatePayload
*
@@ -96,16 +89,6 @@ export const zIndexingEstimatePayload = z.object({
process_rule: z.record(z.string(), z.unknown()),
})
/**
* NotionEstimatePayload
*/
export const zNotionEstimatePayload = z.object({
doc_form: z.string().optional().default('text_model'),
doc_language: z.string().optional().default('English'),
notion_info_list: z.array(z.record(z.string(), z.unknown())),
process_rule: z.record(z.string(), z.unknown()),
})
/**
* RetrievalSettingResponse
*/
@@ -209,6 +192,13 @@ export const zSegmentCreatePayload = z.object({
keywords: z.array(z.string()).nullish(),
})
/**
* BatchImportPayload
*/
export const zBatchImportPayload = z.object({
upload_file_id: z.string(),
})
/**
* SegmentUpdatePayload
*/
@@ -828,14 +818,6 @@ export const zRetrievalMethod = z.enum([
'semantic_search',
])
/**
* PreProcessingRule
*/
export const zPreProcessingRule = z.object({
enabled: z.boolean(),
id: z.enum(['remove_extra_spaces', 'remove_stopwords', 'remove_urls_emails']),
})
/**
* Segmentation
*/
@@ -845,33 +827,6 @@ export const zSegmentation = z.object({
separator: z.string().optional().default('\n'),
})
/**
* Rule
*/
export const zRule = z.object({
parent_mode: z.enum(['full-doc', 'paragraph']).nullish(),
pre_processing_rules: z.array(zPreProcessingRule).nullish(),
segmentation: zSegmentation.nullish(),
subchunk_segmentation: zSegmentation.nullish(),
})
/**
* ProcessRuleResponse
*/
export const zProcessRuleResponse = z.object({
limits: z.record(z.string(), z.unknown()),
mode: zProcessRuleMode,
rules: zRule.nullish(),
})
/**
* ProcessRule
*/
export const zProcessRule = z.object({
mode: zProcessRuleMode,
rules: zRule.nullish(),
})
/**
* MetadataDetail
*/
@@ -1024,49 +979,6 @@ export const zDatasetRetrievalModelResponse = z.object({
weights: zDatasetWeightedScoreResponse.nullish(),
})
/**
* DatasetDetailResponse
*/
export const zDatasetDetailResponse = z.object({
app_count: z.int(),
author_name: z.string().nullable(),
built_in_field_enabled: z.boolean(),
chunk_structure: z.string().nullable(),
created_at: z.int(),
created_by: z.string(),
data_source_type: z.string().nullable(),
description: z.string().nullable(),
doc_form: z.string().nullable(),
doc_metadata: z.array(zDatasetDocMetadataResponse),
document_count: z.int(),
embedding_available: z.boolean().nullish(),
embedding_model: z.string().nullable(),
embedding_model_provider: z.string().nullable(),
enable_api: z.boolean(),
external_knowledge_info: zDatasetExternalKnowledgeInfoResponse.optional(),
external_retrieval_model: zDatasetExternalRetrievalModelResponse.nullable(),
icon_info: zDatasetIconInfoResponse.optional(),
id: z.string(),
indexing_technique: z.string().nullable(),
is_multimodal: z.boolean(),
is_published: z.boolean(),
maintainer: z.string().nullish(),
name: z.string(),
permission: z.string(),
permission_keys: z.array(z.string()).optional(),
pipeline_id: z.string().nullable(),
provider: z.string(),
retrieval_model_dict: zDatasetRetrievalModelResponse,
runtime_mode: z.string().nullable(),
summary_index_setting: zDatasetSummaryIndexSettingResponse.optional(),
tags: z.array(zDatasetTagResponse),
total_available_documents: z.int(),
total_documents: z.int(),
updated_at: z.int(),
updated_by: z.string().nullable(),
word_count: z.int(),
})
/**
* DatasetDetailWithPartialMembersResponse
*/
@@ -1111,6 +1023,49 @@ export const zDatasetDetailWithPartialMembersResponse = z.object({
word_count: z.int(),
})
/**
* DatasetDetailResponse
*/
export const zDatasetDetailResponse = z.object({
app_count: z.int(),
author_name: z.string().nullable(),
built_in_field_enabled: z.boolean(),
chunk_structure: z.string().nullable(),
created_at: z.int(),
created_by: z.string(),
data_source_type: z.string().nullable(),
description: z.string().nullable(),
doc_form: z.string().nullable(),
doc_metadata: z.array(zDatasetDocMetadataResponse),
document_count: z.int(),
embedding_available: z.boolean().nullish(),
embedding_model: z.string().nullable(),
embedding_model_provider: z.string().nullable(),
enable_api: z.boolean(),
external_knowledge_info: zDatasetExternalKnowledgeInfoResponse.optional(),
external_retrieval_model: zDatasetExternalRetrievalModelResponse.nullable(),
icon_info: zDatasetIconInfoResponse.optional(),
id: z.string(),
indexing_technique: z.string().nullable(),
is_multimodal: z.boolean(),
is_published: z.boolean(),
maintainer: z.string().nullish(),
name: z.string(),
permission: z.string(),
permission_keys: z.array(z.string()).optional(),
pipeline_id: z.string().nullable(),
provider: z.string(),
retrieval_model_dict: zDatasetRetrievalModelResponse,
runtime_mode: z.string().nullable(),
summary_index_setting: zDatasetSummaryIndexSettingResponse.optional(),
tags: z.array(zDatasetTagResponse),
total_available_documents: z.int(),
total_documents: z.int(),
updated_at: z.int(),
updated_by: z.string().nullable(),
word_count: z.int(),
})
/**
* DatasetListItemResponse
*/
@@ -1279,6 +1234,79 @@ export const zHitTestingPayload = z.object({
retrieval_model: zRetrievalModel.nullish(),
})
/**
* NotionPageType
*/
export const zNotionPageType = z.enum(['database', 'page'])
/**
* NotionEstimatePagePayload
*/
export const zNotionEstimatePagePayload = z.object({
page_id: z.string().min(1),
type: zNotionPageType,
})
/**
* NotionEstimateWorkspacePayload
*/
export const zNotionEstimateWorkspacePayload = z.object({
credential_id: z.string().min(1),
pages: z.array(zNotionEstimatePagePayload).min(1),
workspace_id: z.string().min(1),
})
/**
* NotionEstimatePayload
*/
export const zNotionEstimatePayload = z.object({
doc_form: z.string().optional().default('text_model'),
doc_language: z.string().optional().default('English'),
notion_info_list: z.array(zNotionEstimateWorkspacePayload).min(1),
process_rule: z.record(z.string(), z.unknown()),
})
export const zPreProcessingRuleKey = z.enum([
'remove_extra_spaces',
'remove_stopwords',
'remove_urls_emails',
])
/**
* PreProcessingRule
*/
export const zPreProcessingRule = z.object({
enabled: z.boolean(),
id: zPreProcessingRuleKey,
})
/**
* Rule
*/
export const zRule = z.object({
parent_mode: z.enum(['full-doc', 'paragraph']).nullish(),
pre_processing_rules: z.array(zPreProcessingRule).nullish(),
segmentation: zSegmentation.nullish(),
subchunk_segmentation: zSegmentation.nullish(),
})
/**
* ProcessRuleResponse
*/
export const zProcessRuleResponse = z.object({
limits: z.record(z.string(), z.unknown()),
mode: zProcessRuleMode,
rules: zRule.nullish(),
})
/**
* ProcessRule
*/
export const zProcessRule = z.object({
mode: zProcessRuleMode,
rules: zRule.nullish(),
})
/**
* HitTestingDocument
*/
@@ -1477,7 +1505,7 @@ export const zPostDatasetsBody = zDatasetCreatePayload
/**
* Dataset created successfully
*/
export const zPostDatasetsResponse = zDatasetDetailResponse
export const zPostDatasetsResponse = zDatasetDetailWithPartialMembersResponse
/**
* API base info retrieved successfully
@@ -1514,17 +1542,6 @@ export const zGetDatasetsBatchImportStatusByJobIdPath = z.object({
*/
export const zGetDatasetsBatchImportStatusByJobIdResponse = zSegmentBatchImportStatusResponse
export const zPostDatasetsBatchImportStatusByJobIdBody = zBatchImportPayload
export const zPostDatasetsBatchImportStatusByJobIdPath = z.object({
job_id: z.uuid(),
})
/**
* Batch import started
*/
export const zPostDatasetsBatchImportStatusByJobIdResponse = zSegmentBatchImportStatusResponse
export const zPostDatasetsExternalBody = zExternalDatasetCreatePayload
/**
@@ -1990,17 +2007,6 @@ export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsQuery = z.objec
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsResponse =
zConsoleSegmentListResponse
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportPath = z.object({
dataset_id: z.uuid(),
document_id: z.uuid(),
})
/**
* Batch import status
*/
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportResponse =
zSegmentBatchImportStatusResponse
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportBody =
zBatchImportPayload
packages/contracts/generated/api/console/notion/types.gen.ts
+3 -1
View File
@@ -25,7 +25,7 @@ export type NotionIntegratePageResponse = {
page_id: string
page_name: string
parent_id: string | null
type: string
type: NotionPageType
}
export type DataSourceIntegrateIconResponse = {
@@ -34,6 +34,8 @@ export type DataSourceIntegrateIconResponse = {
url?: string | null
}
export type NotionPageType = 'database' | 'page'
export type GetNotionPagesByPageIdByPageTypePreviewData = {
body?: never
path: {
packages/contracts/generated/api/console/notion/zod.gen.ts
+6 -1
View File
@@ -18,6 +18,11 @@ export const zDataSourceIntegrateIconResponse = z.object({
url: z.string().nullish(),
})
/**
* NotionPageType
*/
export const zNotionPageType = z.enum(['database', 'page'])
/**
* NotionIntegratePageResponse
*/
@@ -27,7 +32,7 @@ export const zNotionIntegratePageResponse = z.object({
page_id: z.string(),
page_name: z.string(),
parent_id: z.string().nullable(),
type: z.string(),
type: zNotionPageType,
})
/**
packages/contracts/generated/api/service/types.gen.ts
+3 -1
View File
@@ -1777,9 +1777,11 @@ export type PipelineUploadFileResponse = {
export type PreProcessingRule = {
enabled: boolean
id: 'remove_extra_spaces' | 'remove_stopwords' | 'remove_urls_emails'
id: PreProcessingRuleKey
}
export type PreProcessingRuleKey = 'remove_extra_spaces' | 'remove_stopwords' | 'remove_urls_emails'
export type ProcessRule = {
mode: ProcessRuleMode
rules?: Rule | null
packages/contracts/generated/api/service/zod.gen.ts
+7 -1
View File
@@ -1664,12 +1664,18 @@ export const zPipelineUploadFileResponse = z.object({
size: z.int(),
})
export const zPreProcessingRuleKey = z.enum([
'remove_extra_spaces',
'remove_stopwords',
'remove_urls_emails',
])
/**
* PreProcessingRule
*/
export const zPreProcessingRule = z.object({
enabled: z.boolean(),
id: z.enum(['remove_extra_spaces', 'remove_stopwords', 'remove_urls_emails']),
id: zPreProcessingRuleKey,
})
/**