Files
dify/packages/contracts/generated/api/console/datasets/orpc.gen.ts
2026-04-30 11:34:27 +00:00

1787 lines
53 KiB
TypeScript

// This file is auto-generated by @hey-api/openapi-ts
import { oc } from '@orpc/contract'
import * as z from 'zod'
import {
zDeleteDatasetsApiKeysByApiKeyIdPath,
zDeleteDatasetsApiKeysByApiKeyIdResponse,
zDeleteDatasetsByDatasetIdDocumentsByDocumentIdPath,
zDeleteDatasetsByDatasetIdDocumentsByDocumentIdResponse,
zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdPath,
zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdResponse,
zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdPath,
zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdResponse,
zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsPath,
zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsResponse,
zDeleteDatasetsByDatasetIdDocumentsPath,
zDeleteDatasetsByDatasetIdDocumentsResponse,
zDeleteDatasetsByDatasetIdMetadataByMetadataIdPath,
zDeleteDatasetsByDatasetIdMetadataByMetadataIdResponse,
zDeleteDatasetsByDatasetIdPath,
zDeleteDatasetsByDatasetIdResponse,
zDeleteDatasetsByResourceIdApiKeysByApiKeyIdPath,
zDeleteDatasetsByResourceIdApiKeysByApiKeyIdResponse,
zDeleteDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdPath,
zDeleteDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdResponse,
zGetDatasetsApiBaseInfoResponse,
zGetDatasetsApiKeysResponse,
zGetDatasetsBatchImportStatusByJobIdPath,
zGetDatasetsBatchImportStatusByJobIdResponse,
zGetDatasetsByDatasetIdAutoDisableLogsPath,
zGetDatasetsByDatasetIdAutoDisableLogsResponse,
zGetDatasetsByDatasetIdBatchByBatchIndexingEstimatePath,
zGetDatasetsByDatasetIdBatchByBatchIndexingEstimateResponse,
zGetDatasetsByDatasetIdBatchByBatchIndexingStatusPath,
zGetDatasetsByDatasetIdBatchByBatchIndexingStatusResponse,
zGetDatasetsByDatasetIdDocumentsByDocumentIdDownloadPath,
zGetDatasetsByDatasetIdDocumentsByDocumentIdDownloadResponse,
zGetDatasetsByDatasetIdDocumentsByDocumentIdIndexingEstimatePath,
zGetDatasetsByDatasetIdDocumentsByDocumentIdIndexingEstimateResponse,
zGetDatasetsByDatasetIdDocumentsByDocumentIdIndexingStatusPath,
zGetDatasetsByDatasetIdDocumentsByDocumentIdIndexingStatusResponse,
zGetDatasetsByDatasetIdDocumentsByDocumentIdNotionSyncPath,
zGetDatasetsByDatasetIdDocumentsByDocumentIdNotionSyncResponse,
zGetDatasetsByDatasetIdDocumentsByDocumentIdPath,
zGetDatasetsByDatasetIdDocumentsByDocumentIdPipelineExecutionLogPath,
zGetDatasetsByDatasetIdDocumentsByDocumentIdPipelineExecutionLogResponse,
zGetDatasetsByDatasetIdDocumentsByDocumentIdQuery,
zGetDatasetsByDatasetIdDocumentsByDocumentIdResponse,
zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportPath,
zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportResponse,
zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksPath,
zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksResponse,
zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsPath,
zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsResponse,
zGetDatasetsByDatasetIdDocumentsByDocumentIdSummaryStatusPath,
zGetDatasetsByDatasetIdDocumentsByDocumentIdSummaryStatusResponse,
zGetDatasetsByDatasetIdDocumentsByDocumentIdWebsiteSyncPath,
zGetDatasetsByDatasetIdDocumentsByDocumentIdWebsiteSyncResponse,
zGetDatasetsByDatasetIdDocumentsPath,
zGetDatasetsByDatasetIdDocumentsQuery,
zGetDatasetsByDatasetIdDocumentsResponse,
zGetDatasetsByDatasetIdErrorDocsPath,
zGetDatasetsByDatasetIdErrorDocsResponse,
zGetDatasetsByDatasetIdIndexingStatusPath,
zGetDatasetsByDatasetIdIndexingStatusResponse,
zGetDatasetsByDatasetIdMetadataPath,
zGetDatasetsByDatasetIdMetadataResponse,
zGetDatasetsByDatasetIdNotionSyncPath,
zGetDatasetsByDatasetIdNotionSyncResponse,
zGetDatasetsByDatasetIdPath,
zGetDatasetsByDatasetIdPermissionPartUsersPath,
zGetDatasetsByDatasetIdPermissionPartUsersResponse,
zGetDatasetsByDatasetIdQueriesPath,
zGetDatasetsByDatasetIdQueriesResponse,
zGetDatasetsByDatasetIdRelatedAppsPath,
zGetDatasetsByDatasetIdRelatedAppsResponse,
zGetDatasetsByDatasetIdResponse,
zGetDatasetsByDatasetIdUseCheckPath,
zGetDatasetsByDatasetIdUseCheckResponse,
zGetDatasetsByResourceIdApiKeysPath,
zGetDatasetsByResourceIdApiKeysResponse,
zGetDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdPath,
zGetDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdResponse,
zGetDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdUseCheckPath,
zGetDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdUseCheckResponse,
zGetDatasetsExternalKnowledgeApiQuery,
zGetDatasetsExternalKnowledgeApiResponse,
zGetDatasetsMetadataBuiltInResponse,
zGetDatasetsNotionIndexingEstimateResponse,
zGetDatasetsProcessRuleQuery,
zGetDatasetsProcessRuleResponse,
zGetDatasetsQuery,
zGetDatasetsResponse,
zGetDatasetsRetrievalSettingByVectorTypePath,
zGetDatasetsRetrievalSettingByVectorTypeResponse,
zGetDatasetsRetrievalSettingResponse,
zPatchDatasetsByDatasetIdBody,
zPatchDatasetsByDatasetIdDocumentsByDocumentIdProcessingByActionPath,
zPatchDatasetsByDatasetIdDocumentsByDocumentIdProcessingByActionResponse,
zPatchDatasetsByDatasetIdDocumentsByDocumentIdProcessingPausePath,
zPatchDatasetsByDatasetIdDocumentsByDocumentIdProcessingPauseResponse,
zPatchDatasetsByDatasetIdDocumentsByDocumentIdProcessingResumePath,
zPatchDatasetsByDatasetIdDocumentsByDocumentIdProcessingResumeResponse,
zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentByActionPath,
zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentByActionResponse,
zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdBody,
zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdBody,
zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdPath,
zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdResponse,
zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksPath,
zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksResponse,
zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdPath,
zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdResponse,
zPatchDatasetsByDatasetIdDocumentsStatusByActionBatchPath,
zPatchDatasetsByDatasetIdDocumentsStatusByActionBatchResponse,
zPatchDatasetsByDatasetIdMetadataByMetadataIdBody,
zPatchDatasetsByDatasetIdMetadataByMetadataIdPath,
zPatchDatasetsByDatasetIdMetadataByMetadataIdResponse,
zPatchDatasetsByDatasetIdPath,
zPatchDatasetsByDatasetIdResponse,
zPatchDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdBody,
zPatchDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdPath,
zPatchDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdResponse,
zPostDatasetsApiKeysResponse,
zPostDatasetsBatchImportStatusByJobIdBody,
zPostDatasetsBatchImportStatusByJobIdPath,
zPostDatasetsBatchImportStatusByJobIdResponse,
zPostDatasetsBody,
zPostDatasetsByDatasetIdApiKeysByStatusPath,
zPostDatasetsByDatasetIdApiKeysByStatusResponse,
zPostDatasetsByDatasetIdDocumentsBody,
zPostDatasetsByDatasetIdDocumentsByDocumentIdRenameBody,
zPostDatasetsByDatasetIdDocumentsByDocumentIdRenamePath,
zPostDatasetsByDatasetIdDocumentsByDocumentIdRenameResponse,
zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentBody,
zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentPath,
zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentResponse,
zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportBody,
zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportPath,
zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportResponse,
zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksBody,
zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksPath,
zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksResponse,
zPostDatasetsByDatasetIdDocumentsDownloadZipBody,
zPostDatasetsByDatasetIdDocumentsDownloadZipPath,
zPostDatasetsByDatasetIdDocumentsDownloadZipResponse,
zPostDatasetsByDatasetIdDocumentsGenerateSummaryBody,
zPostDatasetsByDatasetIdDocumentsGenerateSummaryPath,
zPostDatasetsByDatasetIdDocumentsGenerateSummaryResponse,
zPostDatasetsByDatasetIdDocumentsMetadataBody,
zPostDatasetsByDatasetIdDocumentsMetadataPath,
zPostDatasetsByDatasetIdDocumentsMetadataResponse,
zPostDatasetsByDatasetIdDocumentsPath,
zPostDatasetsByDatasetIdDocumentsResponse,
zPostDatasetsByDatasetIdExternalHitTestingBody,
zPostDatasetsByDatasetIdExternalHitTestingPath,
zPostDatasetsByDatasetIdExternalHitTestingResponse,
zPostDatasetsByDatasetIdHitTestingBody,
zPostDatasetsByDatasetIdHitTestingPath,
zPostDatasetsByDatasetIdHitTestingResponse,
zPostDatasetsByDatasetIdMetadataBody,
zPostDatasetsByDatasetIdMetadataBuiltInByActionPath,
zPostDatasetsByDatasetIdMetadataBuiltInByActionResponse,
zPostDatasetsByDatasetIdMetadataPath,
zPostDatasetsByDatasetIdMetadataResponse,
zPostDatasetsByDatasetIdRetryBody,
zPostDatasetsByDatasetIdRetryPath,
zPostDatasetsByDatasetIdRetryResponse,
zPostDatasetsByResourceIdApiKeysPath,
zPostDatasetsByResourceIdApiKeysResponse,
zPostDatasetsExternalBody,
zPostDatasetsExternalKnowledgeApiBody,
zPostDatasetsExternalKnowledgeApiResponse,
zPostDatasetsExternalResponse,
zPostDatasetsIndexingEstimateBody,
zPostDatasetsIndexingEstimateResponse,
zPostDatasetsInitBody,
zPostDatasetsInitResponse,
zPostDatasetsNotionIndexingEstimateBody,
zPostDatasetsNotionIndexingEstimateResponse,
zPostDatasetsResponse,
zPutDatasetsByDatasetIdDocumentsByDocumentIdMetadataBody,
zPutDatasetsByDatasetIdDocumentsByDocumentIdMetadataPath,
zPutDatasetsByDatasetIdDocumentsByDocumentIdMetadataResponse,
} from './zod.gen'
/**
* Get dataset API base information
*/
export const get = oc
.route({
description: 'Get dataset API base information',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsApiBaseInfo',
path: '/datasets/api-base-info',
tags: ['console'],
})
.output(zGetDatasetsApiBaseInfoResponse)
export const apiBaseInfo = {
get,
}
/**
* Delete dataset API key
*/
export const delete_ = oc
.route({
description: 'Delete dataset API key',
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteDatasetsApiKeysByApiKeyId',
path: '/datasets/api-keys/{api_key_id}',
successStatus: 204,
tags: ['console'],
})
.input(z.object({ params: zDeleteDatasetsApiKeysByApiKeyIdPath }))
.output(zDeleteDatasetsApiKeysByApiKeyIdResponse)
export const byApiKeyId = {
delete: delete_,
}
/**
* Get dataset API keys
*/
export const get2 = oc
.route({
description: 'Get dataset API keys',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsApiKeys',
path: '/datasets/api-keys',
tags: ['console'],
})
.output(zGetDatasetsApiKeysResponse)
export const post = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsApiKeys',
path: '/datasets/api-keys',
tags: ['console'],
})
.output(zPostDatasetsApiKeysResponse)
export const apiKeys = {
get: get2,
post,
byApiKeyId,
}
export const get3 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsBatchImportStatusByJobId',
path: '/datasets/batch_import_status/{job_id}',
tags: ['console'],
})
.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 = {
byJobId,
}
/**
* Create external knowledge dataset
*/
export const post3 = oc
.route({
description: 'Create external knowledge dataset',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsExternal',
path: '/datasets/external',
successStatus: 201,
tags: ['console'],
})
.input(z.object({ body: zPostDatasetsExternalBody }))
.output(zPostDatasetsExternalResponse)
export const external = {
post: post3,
}
/**
* Check if external knowledge API is being used
*/
export const get4 = oc
.route({
description: 'Check if external knowledge API is being used',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdUseCheck',
path: '/datasets/external-knowledge-api/{external_knowledge_api_id}/use-check',
tags: ['console'],
})
.input(z.object({ params: zGetDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdUseCheckPath }))
.output(zGetDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdUseCheckResponse)
export const useCheck = {
get: get4,
}
export const delete2 = oc
.route({
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteDatasetsExternalKnowledgeApiByExternalKnowledgeApiId',
path: '/datasets/external-knowledge-api/{external_knowledge_api_id}',
tags: ['console'],
})
.input(z.object({ params: zDeleteDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdPath }))
.output(zDeleteDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdResponse)
/**
* Get external knowledge API template details
*/
export const get5 = oc
.route({
description: 'Get external knowledge API template details',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsExternalKnowledgeApiByExternalKnowledgeApiId',
path: '/datasets/external-knowledge-api/{external_knowledge_api_id}',
tags: ['console'],
})
.input(z.object({ params: zGetDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdPath }))
.output(zGetDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdResponse)
export const patch = oc
.route({
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchDatasetsExternalKnowledgeApiByExternalKnowledgeApiId',
path: '/datasets/external-knowledge-api/{external_knowledge_api_id}',
tags: ['console'],
})
.input(
z.object({
body: zPatchDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdBody,
params: zPatchDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdPath,
}),
)
.output(zPatchDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdResponse)
export const byExternalKnowledgeApiId = {
delete: delete2,
get: get5,
patch,
useCheck,
}
/**
* Get external knowledge API templates
*/
export const get6 = oc
.route({
description: 'Get external knowledge API templates',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsExternalKnowledgeApi',
path: '/datasets/external-knowledge-api',
tags: ['console'],
})
.input(z.object({ query: zGetDatasetsExternalKnowledgeApiQuery.optional() }))
.output(zGetDatasetsExternalKnowledgeApiResponse)
export const post4 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsExternalKnowledgeApi',
path: '/datasets/external-knowledge-api',
tags: ['console'],
})
.input(z.object({ body: zPostDatasetsExternalKnowledgeApiBody }))
.output(zPostDatasetsExternalKnowledgeApiResponse)
export const externalKnowledgeApi = {
get: get6,
post: post4,
byExternalKnowledgeApiId,
}
/**
* Estimate dataset indexing cost
*/
export const post5 = oc
.route({
description: 'Estimate dataset indexing cost',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsIndexingEstimate',
path: '/datasets/indexing-estimate',
tags: ['console'],
})
.input(z.object({ body: zPostDatasetsIndexingEstimateBody }))
.output(zPostDatasetsIndexingEstimateResponse)
export const indexingEstimate = {
post: post5,
}
/**
* Initialize dataset with documents
*/
export const post6 = oc
.route({
description: 'Initialize dataset with documents',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsInit',
path: '/datasets/init',
successStatus: 201,
tags: ['console'],
})
.input(z.object({ body: zPostDatasetsInitBody }))
.output(zPostDatasetsInitResponse)
export const init = {
post: post6,
}
export const get7 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsMetadataBuiltIn',
path: '/datasets/metadata/built-in',
tags: ['console'],
})
.output(zGetDatasetsMetadataBuiltInResponse)
export const builtIn = {
get: get7,
}
export const metadata = {
builtIn,
}
export const get8 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsNotionIndexingEstimate',
path: '/datasets/notion-indexing-estimate',
tags: ['console'],
})
.output(zGetDatasetsNotionIndexingEstimateResponse)
export const post7 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsNotionIndexingEstimate',
path: '/datasets/notion-indexing-estimate',
tags: ['console'],
})
.input(z.object({ body: zPostDatasetsNotionIndexingEstimateBody }))
.output(zPostDatasetsNotionIndexingEstimateResponse)
export const notionIndexingEstimate = {
get: get8,
post: post7,
}
/**
* Get dataset document processing rules
*/
export const get9 = oc
.route({
description: 'Get dataset document processing rules',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsProcessRule',
path: '/datasets/process-rule',
tags: ['console'],
})
.input(z.object({ query: zGetDatasetsProcessRuleQuery.optional() }))
.output(zGetDatasetsProcessRuleResponse)
export const processRule = {
get: get9,
}
/**
* Get mock dataset retrieval settings by vector type
*/
export const get10 = oc
.route({
description: 'Get mock dataset retrieval settings by vector type',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsRetrievalSettingByVectorType',
path: '/datasets/retrieval-setting/{vector_type}',
tags: ['console'],
})
.input(z.object({ params: zGetDatasetsRetrievalSettingByVectorTypePath }))
.output(zGetDatasetsRetrievalSettingByVectorTypeResponse)
export const byVectorType = {
get: get10,
}
/**
* Get dataset retrieval settings
*/
export const get11 = oc
.route({
description: 'Get dataset retrieval settings',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsRetrievalSetting',
path: '/datasets/retrieval-setting',
tags: ['console'],
})
.output(zGetDatasetsRetrievalSettingResponse)
export const retrievalSetting = {
get: get11,
byVectorType,
}
export const post8 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdApiKeysByStatus',
path: '/datasets/{dataset_id}/api-keys/{status}',
tags: ['console'],
})
.input(z.object({ params: zPostDatasetsByDatasetIdApiKeysByStatusPath }))
.output(zPostDatasetsByDatasetIdApiKeysByStatusResponse)
export const byStatus = {
post: post8,
}
export const apiKeys2 = {
byStatus,
}
/**
* Get dataset auto disable logs
*/
export const get12 = oc
.route({
description: 'Get dataset auto disable logs',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdAutoDisableLogs',
path: '/datasets/{dataset_id}/auto-disable-logs',
tags: ['console'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdAutoDisableLogsPath }))
.output(zGetDatasetsByDatasetIdAutoDisableLogsResponse)
export const autoDisableLogs = {
get: get12,
}
export const get13 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdBatchByBatchIndexingEstimate',
path: '/datasets/{dataset_id}/batch/{batch}/indexing-estimate',
tags: ['console'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdBatchByBatchIndexingEstimatePath }))
.output(zGetDatasetsByDatasetIdBatchByBatchIndexingEstimateResponse)
export const indexingEstimate2 = {
get: get13,
}
export const get14 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdBatchByBatchIndexingStatus',
path: '/datasets/{dataset_id}/batch/{batch}/indexing-status',
tags: ['console'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdBatchByBatchIndexingStatusPath }))
.output(zGetDatasetsByDatasetIdBatchByBatchIndexingStatusResponse)
export const indexingStatus = {
get: get14,
}
export const byBatch = {
indexingEstimate: indexingEstimate2,
indexingStatus,
}
export const batch = {
byBatch,
}
/**
* Stream a ZIP archive containing the requested uploaded documents
*
* Download selected dataset documents as a single ZIP archive (upload-file only)
*/
export const post9 = oc
.route({
description: 'Download selected dataset documents as a single ZIP archive (upload-file only)',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdDocumentsDownloadZip',
path: '/datasets/{dataset_id}/documents/download-zip',
summary: 'Stream a ZIP archive containing the requested uploaded documents',
tags: ['console'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdDocumentsDownloadZipBody,
params: zPostDatasetsByDatasetIdDocumentsDownloadZipPath,
}),
)
.output(zPostDatasetsByDatasetIdDocumentsDownloadZipResponse)
export const downloadZip = {
post: post9,
}
/**
* Generate summary index for specified documents
*
* Generate summary index for documents
* This endpoint checks if the dataset configuration supports summary generation
* (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
.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.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdDocumentsGenerateSummary',
path: '/datasets/{dataset_id}/documents/generate-summary',
summary: 'Generate summary index for specified documents',
tags: ['console'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdDocumentsGenerateSummaryBody,
params: zPostDatasetsByDatasetIdDocumentsGenerateSummaryPath,
}),
)
.output(zPostDatasetsByDatasetIdDocumentsGenerateSummaryResponse)
export const generateSummary = {
post: post10,
}
export const post11 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdDocumentsMetadata',
path: '/datasets/{dataset_id}/documents/metadata',
tags: ['console'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdDocumentsMetadataBody,
params: zPostDatasetsByDatasetIdDocumentsMetadataPath,
}),
)
.output(zPostDatasetsByDatasetIdDocumentsMetadataResponse)
export const metadata2 = {
post: post11,
}
export const patch2 = oc
.route({
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchDatasetsByDatasetIdDocumentsStatusByActionBatch',
path: '/datasets/{dataset_id}/documents/status/{action}/batch',
tags: ['console'],
})
.input(z.object({ params: zPatchDatasetsByDatasetIdDocumentsStatusByActionBatchPath }))
.output(zPatchDatasetsByDatasetIdDocumentsStatusByActionBatchResponse)
export const batch2 = {
patch: patch2,
}
export const byAction = {
batch: batch2,
}
export const status = {
byAction,
}
/**
* Get a signed download URL for a dataset document's original uploaded file
*/
export const get15 = oc
.route({
description: 'Get a signed download URL for a dataset document\'s original uploaded file',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdDocumentsByDocumentIdDownload',
path: '/datasets/{dataset_id}/documents/{document_id}/download',
tags: ['console'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdDocumentsByDocumentIdDownloadPath }))
.output(zGetDatasetsByDatasetIdDocumentsByDocumentIdDownloadResponse)
export const download = {
get: get15,
}
/**
* Estimate document indexing cost
*/
export const get16 = oc
.route({
description: 'Estimate document indexing cost',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdDocumentsByDocumentIdIndexingEstimate',
path: '/datasets/{dataset_id}/documents/{document_id}/indexing-estimate',
tags: ['console'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdDocumentsByDocumentIdIndexingEstimatePath }))
.output(zGetDatasetsByDatasetIdDocumentsByDocumentIdIndexingEstimateResponse)
export const indexingEstimate3 = {
get: get16,
}
/**
* Get document indexing status
*/
export const get17 = oc
.route({
description: 'Get document indexing status',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdDocumentsByDocumentIdIndexingStatus',
path: '/datasets/{dataset_id}/documents/{document_id}/indexing-status',
tags: ['console'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdDocumentsByDocumentIdIndexingStatusPath }))
.output(zGetDatasetsByDatasetIdDocumentsByDocumentIdIndexingStatusResponse)
export const indexingStatus2 = {
get: get17,
}
/**
* Update document metadata
*/
export const put = oc
.route({
description: 'Update document metadata',
inputStructure: 'detailed',
method: 'PUT',
operationId: 'putDatasetsByDatasetIdDocumentsByDocumentIdMetadata',
path: '/datasets/{dataset_id}/documents/{document_id}/metadata',
tags: ['console'],
})
.input(
z.object({
body: zPutDatasetsByDatasetIdDocumentsByDocumentIdMetadataBody,
params: zPutDatasetsByDatasetIdDocumentsByDocumentIdMetadataPath,
}),
)
.output(zPutDatasetsByDatasetIdDocumentsByDocumentIdMetadataResponse)
export const metadata3 = {
put,
}
export const get18 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdDocumentsByDocumentIdNotionSync',
path: '/datasets/{dataset_id}/documents/{document_id}/notion/sync',
tags: ['console'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdDocumentsByDocumentIdNotionSyncPath }))
.output(zGetDatasetsByDatasetIdDocumentsByDocumentIdNotionSyncResponse)
export const sync = {
get: get18,
}
export const notion = {
sync,
}
export const get19 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdDocumentsByDocumentIdPipelineExecutionLog',
path: '/datasets/{dataset_id}/documents/{document_id}/pipeline-execution-log',
tags: ['console'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdDocumentsByDocumentIdPipelineExecutionLogPath }))
.output(zGetDatasetsByDatasetIdDocumentsByDocumentIdPipelineExecutionLogResponse)
export const pipelineExecutionLog = {
get: get19,
}
/**
* pause document
*/
export const patch3 = oc
.route({
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchDatasetsByDatasetIdDocumentsByDocumentIdProcessingPause',
path: '/datasets/{dataset_id}/documents/{document_id}/processing/pause',
summary: 'pause document',
tags: ['console'],
})
.input(z.object({ params: zPatchDatasetsByDatasetIdDocumentsByDocumentIdProcessingPausePath }))
.output(zPatchDatasetsByDatasetIdDocumentsByDocumentIdProcessingPauseResponse)
export const pause = {
patch: patch3,
}
/**
* recover document
*/
export const patch4 = oc
.route({
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchDatasetsByDatasetIdDocumentsByDocumentIdProcessingResume',
path: '/datasets/{dataset_id}/documents/{document_id}/processing/resume',
summary: 'recover document',
tags: ['console'],
})
.input(z.object({ params: zPatchDatasetsByDatasetIdDocumentsByDocumentIdProcessingResumePath }))
.output(zPatchDatasetsByDatasetIdDocumentsByDocumentIdProcessingResumeResponse)
export const resume = {
patch: patch4,
}
/**
* Update document processing status (pause/resume)
*/
export const patch5 = oc
.route({
description: 'Update document processing status (pause/resume)',
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchDatasetsByDatasetIdDocumentsByDocumentIdProcessingByAction',
path: '/datasets/{dataset_id}/documents/{document_id}/processing/{action}',
tags: ['console'],
})
.input(z.object({ params: zPatchDatasetsByDatasetIdDocumentsByDocumentIdProcessingByActionPath }))
.output(zPatchDatasetsByDatasetIdDocumentsByDocumentIdProcessingByActionResponse)
export const byAction2 = {
patch: patch5,
}
export const processing = {
pause,
resume,
byAction: byAction2,
}
export const post12 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdDocumentsByDocumentIdRename',
path: '/datasets/{dataset_id}/documents/{document_id}/rename',
tags: ['console'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdDocumentsByDocumentIdRenameBody,
params: zPostDatasetsByDatasetIdDocumentsByDocumentIdRenamePath,
}),
)
.output(zPostDatasetsByDatasetIdDocumentsByDocumentIdRenameResponse)
export const rename = {
post: post12,
}
export const patch6 = oc
.route({
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchDatasetsByDatasetIdDocumentsByDocumentIdSegmentByAction',
path: '/datasets/{dataset_id}/documents/{document_id}/segment/{action}',
tags: ['console'],
})
.input(z.object({ params: zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentByActionPath }))
.output(zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentByActionResponse)
export const byAction3 = {
patch: patch6,
}
export const post13 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdDocumentsByDocumentIdSegment',
path: '/datasets/{dataset_id}/documents/{document_id}/segment',
tags: ['console'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentBody,
params: zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentPath,
}),
)
.output(zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentResponse)
export const segment = {
post: post13,
byAction: byAction3,
}
export const get20 = 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
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImport',
path: '/datasets/{dataset_id}/documents/{document_id}/segments/batch_import',
tags: ['console'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportBody,
params: zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportPath,
}),
)
.output(zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportResponse)
export const batchImport = {
get: get20,
post: post14,
}
export const delete3 = oc
.route({
inputStructure: 'detailed',
method: 'DELETE',
operationId:
'deleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkId',
path: '/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}',
tags: ['console'],
})
.input(
z.object({
params:
zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdPath,
}),
)
.output(
zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdResponse,
)
export const patch7 = oc
.route({
inputStructure: 'detailed',
method: 'PATCH',
operationId:
'patchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkId',
path: '/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}',
tags: ['console'],
})
.input(
z.object({
body: zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdBody,
params:
zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdPath,
}),
)
.output(
zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdResponse,
)
export const byChildChunkId = {
delete: delete3,
patch: patch7,
}
export const get21 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunks',
path: '/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks',
tags: ['console'],
})
.input(
z.object({
params: zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksPath,
}),
)
.output(zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksResponse)
export const patch8 = oc
.route({
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunks',
path: '/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks',
tags: ['console'],
})
.input(
z.object({
params: zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksPath,
}),
)
.output(zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksResponse)
export const post15 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunks',
path: '/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks',
tags: ['console'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksBody,
params: zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksPath,
}),
)
.output(zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksResponse)
export const childChunks = {
get: get21,
patch: patch8,
post: post15,
byChildChunkId,
}
export const delete4 = oc
.route({
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentId',
path: '/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}',
tags: ['console'],
})
.input(
z.object({ params: zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdPath }),
)
.output(zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdResponse)
export const patch9 = oc
.route({
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentId',
path: '/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}',
tags: ['console'],
})
.input(
z.object({
body: zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdBody,
params: zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdPath,
}),
)
.output(zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdResponse)
export const bySegmentId = {
delete: delete4,
patch: patch9,
childChunks,
}
export const delete5 = oc
.route({
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteDatasetsByDatasetIdDocumentsByDocumentIdSegments',
path: '/datasets/{dataset_id}/documents/{document_id}/segments',
tags: ['console'],
})
.input(z.object({ params: zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsPath }))
.output(zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsResponse)
export const get22 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdDocumentsByDocumentIdSegments',
path: '/datasets/{dataset_id}/documents/{document_id}/segments',
tags: ['console'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsPath }))
.output(zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsResponse)
export const segments = {
delete: delete5,
get: get22,
batchImport,
bySegmentId,
}
/**
* Get summary index generation status for a document
*
* Get summary index generation status for a document
* Returns:
* - total_segments: Total number of segments in the document
* - summary_status: Dictionary with status counts
* - completed: Number of summaries completed
* - generating: Number of summaries being generated
* - error: Number of summaries with errors
* - not_started: Number of segments without summary records
* - summaries: List of summary records with status and content preview
*/
export const get23 = 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- summaries: List of summary records with status and content preview',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdDocumentsByDocumentIdSummaryStatus',
path: '/datasets/{dataset_id}/documents/{document_id}/summary-status',
summary: 'Get summary index generation status for a document',
tags: ['console'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdDocumentsByDocumentIdSummaryStatusPath }))
.output(zGetDatasetsByDatasetIdDocumentsByDocumentIdSummaryStatusResponse)
export const summaryStatus = {
get: get23,
}
/**
* sync website document
*/
export const get24 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdDocumentsByDocumentIdWebsiteSync',
path: '/datasets/{dataset_id}/documents/{document_id}/website-sync',
summary: 'sync website document',
tags: ['console'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdDocumentsByDocumentIdWebsiteSyncPath }))
.output(zGetDatasetsByDatasetIdDocumentsByDocumentIdWebsiteSyncResponse)
export const websiteSync = {
get: get24,
}
export const delete6 = oc
.route({
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteDatasetsByDatasetIdDocumentsByDocumentId',
path: '/datasets/{dataset_id}/documents/{document_id}',
tags: ['console'],
})
.input(z.object({ params: zDeleteDatasetsByDatasetIdDocumentsByDocumentIdPath }))
.output(zDeleteDatasetsByDatasetIdDocumentsByDocumentIdResponse)
/**
* Get document details
*/
export const get25 = oc
.route({
description: 'Get document details',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdDocumentsByDocumentId',
path: '/datasets/{dataset_id}/documents/{document_id}',
tags: ['console'],
})
.input(
z.object({
params: zGetDatasetsByDatasetIdDocumentsByDocumentIdPath,
query: zGetDatasetsByDatasetIdDocumentsByDocumentIdQuery.optional(),
}),
)
.output(zGetDatasetsByDatasetIdDocumentsByDocumentIdResponse)
export const byDocumentId = {
delete: delete6,
get: get25,
download,
indexingEstimate: indexingEstimate3,
indexingStatus: indexingStatus2,
metadata: metadata3,
notion,
pipelineExecutionLog,
processing,
rename,
segment,
segments,
summaryStatus,
websiteSync,
}
export const delete7 = oc
.route({
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteDatasetsByDatasetIdDocuments',
path: '/datasets/{dataset_id}/documents',
tags: ['console'],
})
.input(z.object({ params: zDeleteDatasetsByDatasetIdDocumentsPath }))
.output(zDeleteDatasetsByDatasetIdDocumentsResponse)
/**
* Get documents in a dataset
*/
export const get26 = oc
.route({
description: 'Get documents in a dataset',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdDocuments',
path: '/datasets/{dataset_id}/documents',
tags: ['console'],
})
.input(
z.object({
params: zGetDatasetsByDatasetIdDocumentsPath,
query: zGetDatasetsByDatasetIdDocumentsQuery.optional(),
}),
)
.output(zGetDatasetsByDatasetIdDocumentsResponse)
export const post16 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdDocuments',
path: '/datasets/{dataset_id}/documents',
tags: ['console'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdDocumentsBody,
params: zPostDatasetsByDatasetIdDocumentsPath,
}),
)
.output(zPostDatasetsByDatasetIdDocumentsResponse)
export const documents = {
delete: delete7,
get: get26,
post: post16,
downloadZip,
generateSummary,
metadata: metadata2,
status,
byDocumentId,
}
/**
* Get dataset error documents
*/
export const get27 = oc
.route({
description: 'Get dataset error documents',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdErrorDocs',
path: '/datasets/{dataset_id}/error-docs',
tags: ['console'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdErrorDocsPath }))
.output(zGetDatasetsByDatasetIdErrorDocsResponse)
export const errorDocs = {
get: get27,
}
/**
* Test external knowledge retrieval for dataset
*/
export const post17 = oc
.route({
description: 'Test external knowledge retrieval for dataset',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdExternalHitTesting',
path: '/datasets/{dataset_id}/external-hit-testing',
tags: ['console'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdExternalHitTestingBody,
params: zPostDatasetsByDatasetIdExternalHitTestingPath,
}),
)
.output(zPostDatasetsByDatasetIdExternalHitTestingResponse)
export const externalHitTesting = {
post: post17,
}
/**
* Test dataset knowledge retrieval
*/
export const post18 = oc
.route({
description: 'Test dataset knowledge retrieval',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdHitTesting',
path: '/datasets/{dataset_id}/hit-testing',
tags: ['console'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdHitTestingBody,
params: zPostDatasetsByDatasetIdHitTestingPath,
}),
)
.output(zPostDatasetsByDatasetIdHitTestingResponse)
export const hitTesting = {
post: post18,
}
/**
* Get dataset indexing status
*/
export const get28 = oc
.route({
description: 'Get dataset indexing status',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdIndexingStatus',
path: '/datasets/{dataset_id}/indexing-status',
tags: ['console'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdIndexingStatusPath }))
.output(zGetDatasetsByDatasetIdIndexingStatusResponse)
export const indexingStatus3 = {
get: get28,
}
export const post19 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdMetadataBuiltInByAction',
path: '/datasets/{dataset_id}/metadata/built-in/{action}',
tags: ['console'],
})
.input(z.object({ params: zPostDatasetsByDatasetIdMetadataBuiltInByActionPath }))
.output(zPostDatasetsByDatasetIdMetadataBuiltInByActionResponse)
export const byAction4 = {
post: post19,
}
export const builtIn2 = {
byAction: byAction4,
}
export const delete8 = oc
.route({
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteDatasetsByDatasetIdMetadataByMetadataId',
path: '/datasets/{dataset_id}/metadata/{metadata_id}',
tags: ['console'],
})
.input(z.object({ params: zDeleteDatasetsByDatasetIdMetadataByMetadataIdPath }))
.output(zDeleteDatasetsByDatasetIdMetadataByMetadataIdResponse)
export const patch10 = oc
.route({
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchDatasetsByDatasetIdMetadataByMetadataId',
path: '/datasets/{dataset_id}/metadata/{metadata_id}',
tags: ['console'],
})
.input(
z.object({
body: zPatchDatasetsByDatasetIdMetadataByMetadataIdBody,
params: zPatchDatasetsByDatasetIdMetadataByMetadataIdPath,
}),
)
.output(zPatchDatasetsByDatasetIdMetadataByMetadataIdResponse)
export const byMetadataId = {
delete: delete8,
patch: patch10,
}
export const get29 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdMetadata',
path: '/datasets/{dataset_id}/metadata',
tags: ['console'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdMetadataPath }))
.output(zGetDatasetsByDatasetIdMetadataResponse)
export const post20 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdMetadata',
path: '/datasets/{dataset_id}/metadata',
tags: ['console'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdMetadataBody,
params: zPostDatasetsByDatasetIdMetadataPath,
}),
)
.output(zPostDatasetsByDatasetIdMetadataResponse)
export const metadata4 = {
get: get29,
post: post20,
builtIn: builtIn2,
byMetadataId,
}
export const get30 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdNotionSync',
path: '/datasets/{dataset_id}/notion/sync',
tags: ['console'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdNotionSyncPath }))
.output(zGetDatasetsByDatasetIdNotionSyncResponse)
export const sync2 = {
get: get30,
}
export const notion2 = {
sync: sync2,
}
/**
* Get dataset permission user list
*/
export const get31 = oc
.route({
description: 'Get dataset permission user list',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdPermissionPartUsers',
path: '/datasets/{dataset_id}/permission-part-users',
tags: ['console'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdPermissionPartUsersPath }))
.output(zGetDatasetsByDatasetIdPermissionPartUsersResponse)
export const permissionPartUsers = {
get: get31,
}
/**
* Get dataset query history
*/
export const get32 = oc
.route({
description: 'Get dataset query history',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdQueries',
path: '/datasets/{dataset_id}/queries',
tags: ['console'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdQueriesPath }))
.output(zGetDatasetsByDatasetIdQueriesResponse)
export const queries = {
get: get32,
}
/**
* Get applications related to dataset
*/
export const get33 = oc
.route({
description: 'Get applications related to dataset',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdRelatedApps',
path: '/datasets/{dataset_id}/related-apps',
tags: ['console'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdRelatedAppsPath }))
.output(zGetDatasetsByDatasetIdRelatedAppsResponse)
export const relatedApps = {
get: get33,
}
/**
* retry document
*/
export const post21 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdRetry',
path: '/datasets/{dataset_id}/retry',
summary: 'retry document',
tags: ['console'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdRetryBody,
params: zPostDatasetsByDatasetIdRetryPath,
}),
)
.output(zPostDatasetsByDatasetIdRetryResponse)
export const retry = {
post: post21,
}
/**
* Check if dataset is in use
*/
export const get34 = oc
.route({
description: 'Check if dataset is in use',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdUseCheck',
path: '/datasets/{dataset_id}/use-check',
tags: ['console'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdUseCheckPath }))
.output(zGetDatasetsByDatasetIdUseCheckResponse)
export const useCheck2 = {
get: get34,
}
export const delete9 = oc
.route({
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteDatasetsByDatasetId',
path: '/datasets/{dataset_id}',
tags: ['console'],
})
.input(z.object({ params: zDeleteDatasetsByDatasetIdPath }))
.output(zDeleteDatasetsByDatasetIdResponse)
/**
* Get dataset details
*/
export const get35 = oc
.route({
description: 'Get dataset details',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetId',
path: '/datasets/{dataset_id}',
tags: ['console'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdPath }))
.output(zGetDatasetsByDatasetIdResponse)
/**
* Update dataset details
*/
export const patch11 = oc
.route({
description: 'Update dataset details',
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchDatasetsByDatasetId',
path: '/datasets/{dataset_id}',
tags: ['console'],
})
.input(z.object({ body: zPatchDatasetsByDatasetIdBody, params: zPatchDatasetsByDatasetIdPath }))
.output(zPatchDatasetsByDatasetIdResponse)
export const byDatasetId = {
delete: delete9,
get: get35,
patch: patch11,
apiKeys: apiKeys2,
autoDisableLogs,
batch,
documents,
errorDocs,
externalHitTesting,
hitTesting,
indexingStatus: indexingStatus3,
metadata: metadata4,
notion: notion2,
permissionPartUsers,
queries,
relatedApps,
retry,
useCheck: useCheck2,
}
/**
* Delete an API key for a dataset
*
* Delete an API key for a dataset
*/
export const delete10 = oc
.route({
description: 'Delete an API key for a dataset',
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteDatasetsByResourceIdApiKeysByApiKeyId',
path: '/datasets/{resource_id}/api-keys/{api_key_id}',
successStatus: 204,
summary: 'Delete an API key for a dataset',
tags: ['console'],
})
.input(z.object({ params: zDeleteDatasetsByResourceIdApiKeysByApiKeyIdPath }))
.output(zDeleteDatasetsByResourceIdApiKeysByApiKeyIdResponse)
export const byApiKeyId2 = {
delete: delete10,
}
/**
* Get all API keys for a dataset
*
* Get all API keys for a dataset
*/
export const get36 = oc
.route({
description: 'Get all API keys for a dataset',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByResourceIdApiKeys',
path: '/datasets/{resource_id}/api-keys',
summary: 'Get all API keys for a dataset',
tags: ['console'],
})
.input(z.object({ params: zGetDatasetsByResourceIdApiKeysPath }))
.output(zGetDatasetsByResourceIdApiKeysResponse)
/**
* Create a new API key for a dataset
*
* Create a new API key for a dataset
*/
export const post22 = oc
.route({
description: 'Create a new API key for a dataset',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByResourceIdApiKeys',
path: '/datasets/{resource_id}/api-keys',
successStatus: 201,
summary: 'Create a new API key for a dataset',
tags: ['console'],
})
.input(z.object({ params: zPostDatasetsByResourceIdApiKeysPath }))
.output(zPostDatasetsByResourceIdApiKeysResponse)
export const apiKeys3 = {
get: get36,
post: post22,
byApiKeyId: byApiKeyId2,
}
export const byResourceId = {
apiKeys: apiKeys3,
}
/**
* Get list of datasets
*/
export const get37 = oc
.route({
description: 'Get list of datasets',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasets',
path: '/datasets',
tags: ['console'],
})
.input(z.object({ query: zGetDatasetsQuery.optional() }))
.output(zGetDatasetsResponse)
/**
* Create a new dataset
*/
export const post23 = oc
.route({
description: 'Create a new dataset',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasets',
path: '/datasets',
successStatus: 201,
tags: ['console'],
})
.input(z.object({ body: zPostDatasetsBody }))
.output(zPostDatasetsResponse)
export const datasets = {
get: get37,
post: post23,
apiBaseInfo,
apiKeys,
batchImportStatus,
external,
externalKnowledgeApi,
indexingEstimate,
init,
metadata,
notionIndexingEstimate,
processRule,
retrievalSetting,
byDatasetId,
byResourceId,
}
export const contract = {
datasets,
}